Components All New MacOS Windows Linux iOS
Examples Mac & Win Server Client Guides Statistic FMM Blog Deprecated Old

14.1 14.2 14.3 14.4 14.5 15.0 15.1 15.2 15.3 15.4 15.5 16.0

New in version 3.5

Item Details Server
Addressbook.LocalizedPropertyOrLabel   Deprecated
Queries a localized name for a label or property.
Mac only
  ❌ Server
Addressbook.Notification.Clear   Deprecated
Clears the registered notification script.
Mac only
  ❌ Server
Addressbook.Notification.GetChangedExternally   Deprecated
Queries if the last notification script call was caused by a changed in another app.
Mac only
  ❌ Server
Addressbook.Notification.GetDeletedRecords   Deprecated
Queries list of deleted records.
Mac only
  ❌ Server
Addressbook.Notification.GetInsertedRecords   Deprecated
Queries list of inserted records.
Mac only
  ❌ Server
Addressbook.Notification.GetProcessID   Deprecated
Queries the process ID.
Mac only
  ❌ Server
Addressbook.Notification.GetProcessName   Deprecated
Queries the process name.
Mac only
  ❌ Server
Addressbook.Notification.GetUpdatedRecords   Deprecated
Queries list of updated records.
Mac only
  ❌ Server
Addressbook.Notification.GetUserUID   Deprecated
Queries the user ID.
Mac only
  ❌ Server
Addressbook.Notification.Set   Deprecated
Installs a notification script.
Mac only
  ❌ Server
Addressbook.personFromVCardTextRepresentation   Deprecated
Creates an Person instance initialized with the given text.
Mac/iOS
  ❌ Server
Addressbook.searchPeopleWithCreationDate   Deprecated
Searches for people in address book with creation date between both dates.
Mac only
  ❌ Server
Addressbook.searchPeopleWithModificationDate   Deprecated
Searches for people in address book with modification date between both dates.
Mac only
  ❌ Server
App.GetProcessPath
Queries the path of the application.
All
  ✅ Server
Barcode.Detect
Detects a barcode.
All
  ✅ Server
Barcode.DrawBarcode
Draws a barcode into a PDF page.
All
  ✅ Server
Barcode.Generate
Generates a barcode.
All
  ✅ Server
Barcode.UPCChecksum
Calculates checksum for UPC barcodes.
All
  ✅ Server
CURL.SetOptionTLSAuthPassword
Sets the TSL authentication password.
All
  ✅ Server
CURL.SetOptionTLSAuthType
Sets the TLS authentication type.
All
  ✅ Server
CURL.SetOptionTLSAuthUsername
Sets the TSL authentication user name.
All
  ✅ Server
Calendar.Alarm.Duplicate   Deprecated
Creates a copy of an alarm.
Mac only
  ❌ Server
Calendar.Alarm.GetAbsoluteTrigger   Deprecated
Queries the absolute trigger timestamp.
Mac only
  ❌ Server
Calendar.Alarm.GetAcknowledged   Deprecated
Queries acknowledged flag.
Mac only
  ❌ Server
Calendar.Alarm.GetAction   Deprecated
Queries the action for this alarm.
Mac only
  ❌ Server
Calendar.Alarm.GetEmailAddress   Deprecated
Queries the email address for an alarm.
Mac only
  ❌ Server
Calendar.Alarm.GetRelatedTo   Deprecated
Queries the related to setting.
Mac only
  ❌ Server
Calendar.Alarm.GetRelativeTrigger   Deprecated
Queries the relative trigger value.
Mac only
  ❌ Server
Calendar.Alarm.GetSound   Deprecated
Queries the sounds for this alarm.
Mac only
  ❌ Server
Calendar.Alarm.GetURL   Deprecated
Queries the URL of the alarm.
Mac only
  ❌ Server
Calendar.Alarm.SetAbsoluteTrigger   Deprecated
Sets the absolute trigger timestamp.
Mac only
  ❌ Server
Calendar.Alarm.SetAcknowledged   Deprecated
Sets acknowledged flag.
Mac only
  ❌ Server
Calendar.Alarm.SetAction   Deprecated
Sets an action for this alarm.
Mac only
  ❌ Server
Calendar.Alarm.SetEmailAddress   Deprecated
Sets the email address for this alarm.
Mac only
  ❌ Server
Calendar.Alarm.SetRelatedTo   Deprecated
Sets the related to setting.
Mac only
  ❌ Server
Calendar.Alarm.SetRelativeTrigger   Deprecated
Sets the relative trigger value.
Mac only
  ❌ Server
Calendar.Alarm.SetSound   Deprecated
Sets the sounds for this alarm.
Mac only
  ❌ Server
Calendar.Alarm.SetURL   Deprecated
Sets the URL of the alarm.
Mac only
  ❌ Server
Calendar.Alarm.TriggerDateRelativeTo   Deprecated
Queries the relative trigger date for this alarm.
Mac only
  ❌ Server
Calendar.Attendee.GetAddress   Deprecated
Returns URL address of attendee entry.
Mac only
  ❌ Server
Calendar.Attendee.GetCommonName   Deprecated
Returns the user-entered name of the attendee.
Mac only
  ❌ Server
Calendar.Attendee.GetStatus   Deprecated
Returns status of attendee.
Mac only
  ❌ Server
Calendar.Item.AddAlarm   Deprecated
Adds an alarm to a calendar item.
Mac only
  ❌ Server
Calendar.Item.GetAlarms   Deprecated
Queries the list of alarms for this item.
Mac only
  ❌ Server
Calendar.Item.GetAttendees   Deprecated
Queries the list of attendees for this event.
Mac only
  ❌ Server
Calendar.Item.RemoveAlarm   Deprecated
Removes an alarm from an item.
Mac only
  ❌ Server
Calendar.NewAlarm   Deprecated
Creates a new alarm.
Mac only
  ❌ Server
Calendar.Notification.Clear   Deprecated
Clears the registered notification script.
Mac only
  ❌ Server
Calendar.Notification.GetChangedExternally   Deprecated
Queries if the last notification script call was caused by a changed in another app.
Mac only
  ❌ Server
Calendar.Notification.GetDeletedRecords   Deprecated
Queries list of deleted records.
Mac only
  ❌ Server
Calendar.Notification.GetInsertedRecords   Deprecated
Queries list of inserted records.
Mac only
  ❌ Server
Calendar.Notification.GetProcessID   Deprecated
Queries the process ID.
Mac only
  ❌ Server
Calendar.Notification.GetProcessName   Deprecated
Queries the process name.
Mac only
  ❌ Server
Calendar.Notification.GetUpdatedRecords   Deprecated
Queries list of updated records.
Mac only
  ❌ Server
Calendar.Notification.GetUserUID   Deprecated
Queries the user ID.
Mac only
  ❌ Server
Calendar.Notification.GetWhat   Deprecated
Queries what changed in the database.
Mac only
  ❌ Server
Calendar.Notification.Set   Deprecated
Installs a notification script.
Mac only
  ❌ Server
DynaPDF.GetImportOrientation
Queries orientation for input page.
All
  ✅ Server
DynaPDF.GetOrientation
Queries orientation of current page.
All
  ✅ Server
DynaPDF.HighlightPattern
Searches a text and adds highlights for it.
All
  ✅ Server
DynaPDF.New
Creates a new DynaPDF instance.
All
  ✅ Server
DynaPDF.Release
Releases a PDF reference.
All
  ✅ Server
DynaPDF.SetOrientation
Changes the orientation of the page.
All
  ✅ Server
DynaPDF.SetOrientationEx
Changes the orientation of the page.
All
  ✅ Server
DynaPDF.Table.AddColumn
Adds a column on the left or right side of the table.
All
  ✅ Server
DynaPDF.Table.AddRow
Adds a new row to the table.
All
  ✅ Server
DynaPDF.Table.AddRows
Adds new rows to the table.
All
  ✅ Server
DynaPDF.Table.ClearColumn
Deletes the content in the specified column in all rows.
All
  ✅ Server
DynaPDF.Table.ClearContent
Deletes the specified object types from the table.
All
  ✅ Server
DynaPDF.Table.ClearRow
The function deletes the content in the specified row.
All
  ✅ Server
DynaPDF.Table.Create
Creates a new table object.
All
  ✅ Server
DynaPDF.Table.DeleteCol
Deletes a column from the table.
All
  ✅ Server
DynaPDF.Table.DeleteRow
Deletes a row from the table.
All
  ✅ Server
DynaPDF.Table.DeleteRows
Deletes all rows from the table.
All
  ✅ Server
DynaPDF.Table.Draw
Draws the table on the specified position.
All
  ✅ Server
DynaPDF.Table.GetFirstRow
Queries first row drawn.
All
  ✅ Server
DynaPDF.Table.GetNextHeight
Calculates the height of the table.
All
  ✅ Server
DynaPDF.Table.GetNextHeightRow
Calculates the height of the table.
All
  ✅ Server
DynaPDF.Table.GetNextRow
Queries next row to be drawn.
All
  ✅ Server
DynaPDF.Table.GetNumCols
Queries number of columns in table.
All
  ✅ Server
DynaPDF.Table.GetNumRows
Queries number of rows in table.
All
  ✅ Server
DynaPDF.Table.GetPDF
Returns the reference to the PDF.
All
  ✅ Server
DynaPDF.Table.GetTableHeight
Returns the full height of the table.
All
  ✅ Server
DynaPDF.Table.GetTableWidth
Returns the width of the table.
All
  ✅ Server
DynaPDF.Table.HaveMore
Checks whether all rows where drawn.
All
  ✅ Server
DynaPDF.Table.Release
Releases the PDF table.
All
  ✅ Server
DynaPDF.Table.SetBorderWidth
Sets or changes the border width.
All
  ✅ Server
DynaPDF.Table.SetBoxProperty
Sets or changes the border width, cell spacing, or cell padding.
All
  ✅ Server
DynaPDF.Table.SetCellImage
Inserts an image horizontally and vertically aligned as specified.
All
  ✅ Server
DynaPDF.Table.SetCellImageEx
Inserts an image from container.
All
  ✅ Server
DynaPDF.Table.SetCellOrientation
Sets the cell orientation.
All
  ✅ Server
DynaPDF.Table.SetCellPadding
Sets or changes the cell padding.
All
  ✅ Server
DynaPDF.Table.SetCellSpacing
Sets or changes the cell spacing.
All
  ✅ Server
DynaPDF.Table.SetCellTable
Inserts a sub table into the specified cell.
All
  ✅ Server
DynaPDF.Table.SetCellTemplate
Inserts a template into the specified cell.
All
  ✅ Server
DynaPDF.Table.SetCellText
Inserts the specified text into the cell.
All
  ✅ Server
DynaPDF.Table.SetColWidth
The function changes the width of a column.
All
  ✅ Server
DynaPDF.Table.SetColor
Sets or changes the specified color as well as the corresponding device color space.
All
  ✅ Server
DynaPDF.Table.SetColorFloat
Sets or changes the specified color and color space.
All
  ✅ Server
DynaPDF.Table.SetFlags
The function sets various flags.
All
  ✅ Server
DynaPDF.Table.SetFont
Sets the font that is used to output text.
All
  ✅ Server
DynaPDF.Table.SetFontSelMode
The function sets or changes the font selection mode.
All
  ✅ Server
DynaPDF.Table.SetFontSize
Sets or changes the font size.
All
  ✅ Server
DynaPDF.Table.SetGridWidth
Sets the grid width.
All
  ✅ Server
DynaPDF.Table.SetPDF
Changes the PDF instance that is associated with the table.
All
  ✅ Server
DynaPDF.Table.SetRGBColor
Sets RGB color.
All
  ✅ Server
DynaPDF.Table.SetRowHeight
Changes the row height.
All
  ✅ Server
DynaPDF.Table.SetTableWidth
Changes the width of the table.
All
  ✅ Server
FM.ExecuteFileSQL
Execute the SQL Statement against a FileMaker database.
All
  ✅ Server
Files.GetTagNames
Queries names of the tags assigned to the file/folder.
Mac only
  ✅ Server
Files.ReadFile
Reads a file with the given path.
All
  ✅ Server
Files.SetTagNames
Sets the tags for a file/folder.
Mac only
  ✅ Server
Files.WriteFile
Writes a file with the given data.
All
  ✅ Server
GMImage.Strip
Remove all profiles and text attributes from the image.
All
  ✅ Server
IKPictureTaker.ClearNotification
Clears the script to be called.
Mac only
  ❌ Server
IKPictureTaker.GetAllowsEditing
Queries whether image editing is allowed.
Mac only
  ❌ Server
IKPictureTaker.GetAllowsFileChoosing
Queries whether image files can be chosen.
Mac only
  ❌ Server
IKPictureTaker.GetAllowsVideoCapture
Queries whether video capture is allowed.
Mac only
  ❌ Server
IKPictureTaker.GetInformationalText
Queries informational text.
Mac only
  ❌ Server
IKPictureTaker.GetInputImage
Return the original PictureTaker's input-image.
Mac only
  ❌ Server
IKPictureTaker.GetMirroring
Queries video mirroring status.
Mac only
  ❌ Server
IKPictureTaker.GetOutputImage
Return the edited image.
Mac only
  ❌ Server
IKPictureTaker.GetOutputImageMaxHeight
Queries the maximum allowed image height.
Mac only
  ❌ Server
IKPictureTaker.GetOutputImageMaxWidth
Queries the maximum allowed image width.
Mac only
  ❌ Server
IKPictureTaker.GetRemainOpenAfterValidate
Queries whether the picture taker should remain open after the user selects done.
Mac only
  ❌ Server
IKPictureTaker.GetShowAddressBookPicture
Queries whether addressbook pictures are shown.
Mac only
  ❌ Server
IKPictureTaker.GetShowEffects
Queries whether to show effects.
Mac only
  ❌ Server
IKPictureTaker.GetShowEmptyPicture
Queries the image to be shown for empty picture.
Mac only
  ❌ Server
IKPictureTaker.GetShowRecentPicture
Queries whether to show recent pictures.
Mac only
  ❌ Server
IKPictureTaker.GetUpdateRecentPicture
Queries whether to allow a recent picture to be updated.
Mac only
  ❌ Server
IKPictureTaker.Run
Launch the PictureTaker.
Mac only
  ❌ Server
IKPictureTaker.SetAllowsEditing
Sets whether image editing is allowed.
Mac only
  ❌ Server
IKPictureTaker.SetAllowsFileChoosing
Sets whether image files can be chosen.
Mac only
  ❌ Server
IKPictureTaker.SetAllowsVideoCapture
Sets whether video capture is allowed.
Mac only
  ❌ Server
IKPictureTaker.SetInformationalText
Sets informational text.
Mac only
  ❌ Server
IKPictureTaker.SetInputImage
Set the image input for the PictureTaker.
Mac only
  ❌ Server
IKPictureTaker.SetMirroring
Controls whether the receiver enable/disable video mirroring durring snapshots (default is on).
Mac only
  ❌ Server
IKPictureTaker.SetNotification
Installs a notification script.
Mac only
  ❌ Server
IKPictureTaker.SetOutputImageMaxSize
Sets maximum size of the output image.
Mac only
  ❌ Server
IKPictureTaker.SetRemainOpenAfterValidate
Sets whether the picture taker should remain open after the user selects done.
Mac only
  ❌ Server
IKPictureTaker.SetShowAddressBookPicture   Deprecated
Sets whether address book pictures are shown.
Mac only
  ❌ Server
IKPictureTaker.SetShowEffects
Sets whether to show effects.
Mac only
  ❌ Server
IKPictureTaker.SetShowEmptyPicture
Sets the image to be shown for empty picture.
Mac only
  ❌ Server
IKPictureTaker.SetShowRecentPicture
Sets whether to show recent pictures.
Mac only
  ❌ Server
IKPictureTaker.SetUpdateRecentPicture
Sets whether to allow a recent picture to be updated.
Mac only
  ❌ Server
MediaLibraryBrowser.getMediaLibraries
Queries which media libraries are currently showing.
Mac only
  ❌ Server
MediaLibraryBrowser.getVisible
Queries visible state of the browser panel.
Mac only
  ❌ Server
MediaLibraryBrowser.setFrame
Sets the panel rectangle.
Mac only
  ❌ Server
MediaLibraryBrowser.setMediaLibraries
Sets which media type is shown in browser.
Mac only
  ❌ Server
MediaLibraryBrowser.setVisible
Sets visible state of the panel.
Mac only
  ❌ Server
MediaLibraryBrowser.togglePanel
Toggles the panel.
Mac only
  ❌ Server
PrintDialog.Disable
Disables the print dialog extension.
Mac only
  ❌ Server
PrintDialog.Enable
Enables the print dialog extension.
Mac only
  ❌ Server
PrintDialog.GetDestinationPath
Queries the destination path.
Mac only
  ❌ Server
PrintDialog.GetNoDialog
Queries whether dialog shows.
Mac only
  ❌ Server
PrintDialog.GetPrintToPDF
Queries whether printing is going to PDF file.
Mac only
  ❌ Server
PrintDialog.GetPrinterName
Queries printer name to use.
Mac only
  ❌ Server
PrintDialog.Install
Installs the extension for the printer dialog.
Mac only
  ❌ Server
PrintDialog.SetDestinationPath
Sets the destination path for PDF.
Mac only
  ❌ Server
PrintDialog.SetNoDialog
Sets whether dialog should show.
Mac only
  ❌ Server
PrintDialog.SetPrintToPDF
Sets whether plugin will redirect print to PDF.
Mac only
  ❌ Server
PrintDialog.SetPrinterName
Sets printer name.
Mac only
  ❌ Server
RichText.Clear
Clears current document.
Mac/iOS
  ✅ Server
RichText.SetAttribute
Sets metadata.
Mac/iOS
  ✅ Server
RichText.SetFormattedText
Sets new text for saving a document.
Mac/iOS
  ✅ Server
RichText.SetText
Sets new text for saving a document.
Mac/iOS
  ✅ Server
RichText.WriteDOC
Writes a Word file.
Mac only
  ✅ Server
RichText.WriteRTF
Writes a RTF file.
Mac/iOS
  ✅ Server
Socket.SSL.Accept
Wait for a TLS/SSL client to initiate a TLS/SSL handshake.
All
  ✅ Server
Socket.SSL.Connect
Initiate the TLS/SSL handshake with an TLS/SSL server.
All
  ✅ Server
Socket.SSL.GetMethod
Queries the SSL method.
All
  ✅ Server
Socket.SSL.Initialize
Initializes a SSL connection.
All
  ✅ Server
Socket.SSL.Prepare
First step in SSL initialization.
All
  ✅ Server
Socket.SSL.SetMethod
Sets the SSL method for this socket.
All
  ✅ Server
Socket.SSL.UseCertificateFile
Defines to use a certificate key file for this SSL socket.
All
  ✅ Server
Socket.SSL.UsePrivateKeyFile
Defines to use a private key file for this SSL socket.
All
  ✅ Server
SyntaxColoring.CheckVariableDeclaration.Disable
Disables checking variable declarations in FileMaker Scripts.
Mac only
  ❌ Server
SyntaxColoring.CheckVariableDeclaration.Enable
Enables checking variable declarations in FileMaker Scripts.
Mac only
  ❌ Server
SyntaxColoring.CheckVariableDeclaration.Enabled
Queries if checking variable declarations are enabled or not.
Mac only
  ❌ Server
SyntaxColoring.LineNumbers.Disable   Deprecated
Disables line numbers in FileMaker Scripts.
Mac only
  ❌ Server
SyntaxColoring.LineNumbers.Enable   Deprecated
Enables line numbers in FileMaker Scripts.
Mac only
  ❌ Server
SyntaxColoring.LineNumbers.Enabled   Deprecated
Queries if line numbers are enabled or not.
Mac only
  ❌ Server
SyntaxColoring.LineNumbers.GetColor   Deprecated
Queries the current color for line numbers.
Mac only
  ❌ Server
SyntaxColoring.LineNumbers.SetColor   Deprecated
Sets the new color to use for line numbers.
Mac only
  ❌ Server
SystemInfo.isMavericks   Deprecated
Whether the operation system is macOS 10.9 Mavericks or newer.
All
  ✅ Server
Text.SoundExGerman
Returns soundex string for the given text.
All
  ✅ Server
Twain.GetAutomaticBrightness
Queries the Source's Auto-brightness function (if any).
Mac/Win
  ❌ Server
Twain.GetBrightness
Queries the brightness setting to use.
Mac/Win
  ❌ Server
Twain.GetContrast
Queries which contrast value to use.
Mac/Win
  ❌ Server
Twain.GetGamma
Queries the gamma correction value for the image data.
Mac/Win
  ❌ Server
Twain.GetHighlight
Queries which value to use for highlight.
Mac/Win
  ❌ Server
Twain.GetShadow
Queries which value in an image should be interpreted as the darkest shadow.
Mac/Win
  ❌ Server
Twain.SetAutomaticBrightness
Enables or disables the Source's Auto-brightness function (if any).
Mac/Win
  ❌ Server
Twain.SetBrightness
Sets the brightness setting to use.
Mac/Win
  ❌ Server
Twain.SetContrast
Sets which contrast value to use.
Mac/Win
  ❌ Server
Twain.SetGamma
Sets the gamma correction value for the image data.
Mac/Win
  ❌ Server
Twain.SetHighlight
Specifies which value in an image should be interpreted as the lightest highlight.
Mac/Win
  ❌ Server
Twain.SetShadow
Specifies which value in an image should be interpreted as the darkest shadow.
Mac/Win
  ❌ Server
UserNotification.ContentImage
Queries image shown in the content of the notification.
Mac only
  ❌ Server
UserNotification.GetIdentifier
Queries the identifier used to uniquely identify a notification.
Mac only
  ❌ Server
UserNotification.GetResponse
Queries the response text.
Mac only
  ❌ Server
UserNotification.GetResponsePlaceholder
Queries the optional placeholder for inline reply field.
Mac only
  ❌ Server
UserNotification.HasReplyButton
Queries whether the notification has a reply button.
Mac only
  ❌ Server
UserNotification.SetContentImage
Sets image shown in the content of the notification.
Mac only
  ❌ Server
UserNotification.SetHasReplyButton
Sets whether the notification has a reply button.
Mac only
  ❌ Server
UserNotification.SetIdentifier
Sets the identifier used to uniquely identify a notification.
Mac only
  ❌ Server
UserNotification.SetResponsePlaceholder
Sets the optional placeholder for inline reply field.
Mac only
  ❌ Server
XL.Book.AddCustomNumFormat
Adds a new custom number format to the workbook.
All
  ✅ Server
XL.Book.AddFont
Adds a new font to the workbook, initial parameters can be copied from other font.
All
  ✅ Server
XL.Book.AddFormat
Adds a new format to the workbook, initial parameters can be copied from other format.
All
  ✅ Server
XL.Book.AddPictureContainer
Adds a picture to the workbook from container.
All
  ✅ Server
XL.Book.AddPictureFile
Adds a picture to the workbook.
All
  ✅ Server
XL.Book.AddSheet
Adds a new sheet to this book, returns the sheet index.
All
  ✅ Server
XL.Book.BiffVersion
Returns BIFF version of binary file.
All
  ✅ Server
XL.Book.CustomNumFormat
Returns a custom format string for specified custom format identifier.
All
  ✅ Server
XL.Book.DeleteSheet
Deletes a sheet with specified index.
All
  ✅ Server
XL.Book.FontCount
Returns a number of fonts in this book.
All
  ✅ Server
XL.Book.FormatCount
Returns a number of formats in this book.
All
  ✅ Server
XL.Book.GetActiveSheet
Returns an active sheet index in this workbook.
All
  ✅ Server
XL.Book.GetDefaultFontName
Returns a default font name for this workbook.
All
  ✅ Server
XL.Book.GetDefaultFontSize
Returns a default font size for this workbook.
All
  ✅ Server
XL.Book.GetPicture
Returns a picture at position index.
All
  ✅ Server
XL.Book.GetPictureType
Returns a picture type at position index.
All
  ✅ Server
XL.Book.GetRGBMode
Returns whether the RGB mode is active.
All
  ✅ Server
XL.Book.GetRefR1C1
Returns whether the R1C1 reference mode is active.
All
  ✅ Server
XL.Book.GetText
Queries the text of a workbook.
All
  ✅ Server
XL.Book.InsertSheet
Inserts a new sheet to this book at position index, returns the new sheet index.
All
  ✅ Server
XL.Book.PictureCount
Returns a number of pictures in this workbook.
All
  ✅ Server
XL.Book.Release
Frees a workbook from memory.
All
  ✅ Server
XL.Book.Save
Writes excel file to container for storing in database.
All
  ✅ Server
XL.Book.SaveToFile
Saves current workbook into xls-file.
All
  ✅ Server
XL.Book.SetActiveSheet
Sets an active sheet index in this workbook.
All
  ✅ Server
XL.Book.SetDefaultFont
Sets a default font name and size for this workbook.
All
  ✅ Server
XL.Book.SetRGBMode
Sets a RGB mode.
All
  ✅ Server
XL.Book.SetRefR1C1
Sets the R1C1 reference mode.
All
  ✅ Server
XL.Book.SheetCount
Queries how many sheets are part of the workbook.
All
  ✅ Server
XL.Color.Pack
Packs red, green and blue components in color type.
All
  ✅ Server
XL.Color.UnPack
Unpacks color type to red, green and blue components.
All
  ✅ Server
XL.Date.Pack
Packs date and time information into double type.
All
  ✅ Server
XL.Date.UnPack
Unpacks date and time information from double type.
All
  ✅ Server
XL.Font.GetBold
Returns whether the font is bold.
All
  ✅ Server
XL.Font.GetColor
Returns the color of the font.
All
  ✅ Server
XL.Font.GetItalic
Returns whether the font is italic.
All
  ✅ Server
XL.Font.GetName
Returns the name of the font.
All
  ✅ Server
XL.Font.GetScript
Returns the script style of the font.
All
  ✅ Server
XL.Font.GetSize
Returns the size of the font in points.
All
  ✅ Server
XL.Font.GetStrikeOut
Returns whether the font is strikeout.
All
  ✅ Server
XL.Font.GetUnderline
Returns the underline style of the font.
All
  ✅ Server
XL.Font.SetBold
Turns on/off the bold font.
All
  ✅ Server
XL.Font.SetColor
Sets the color of the font.
All
  ✅ Server
XL.Font.SetItalic
Turns on/off the italic font.
All
  ✅ Server
XL.Font.SetName
Sets the name of the font.
All
  ✅ Server
XL.Font.SetScript
Sets the script style of the font.
All
  ✅ Server
XL.Font.SetSize
Sets the size of the font in points.
All
  ✅ Server
XL.Font.SetStrikeOut
Turns on/off the strikeout font.
All
  ✅ Server
XL.Font.SetUnderline
Sets the underline style of the font.
All
  ✅ Server
XL.Format.GetAlignH
Returns the horizontal alignment.
All
  ✅ Server
XL.Format.GetAlignV
Returns the vertical alignment.
All
  ✅ Server
XL.Format.GetBorderBottom
Returns the bottom border style.
All
  ✅ Server
XL.Format.GetBorderBottomColor
Returns the color of the bottom border.
All
  ✅ Server
XL.Format.GetBorderDiagonal
Returns the diagonal border.
All
  ✅ Server
XL.Format.GetBorderDiagonalColor
Returns the color of the diagonal border.
All
  ✅ Server
XL.Format.GetBorderDiagonalStyle
Gets the style for diagonal border.
All
  ✅ Server
XL.Format.GetBorderLeft
Returns the left border style.
All
  ✅ Server
XL.Format.GetBorderLeftColor
Returns the color of the left border.
All
  ✅ Server
XL.Format.GetBorderRight
Returns the right border style.
All
  ✅ Server
XL.Format.GetBorderRightColor
Returns the color of the right border.
All
  ✅ Server
XL.Format.GetBorderTop
Returns the top border style.
All
  ✅ Server
XL.Format.GetBorderTopColor
Returns the color of the top border.
All
  ✅ Server
XL.Format.GetFillPattern
Returns the fill pattern.
All
  ✅ Server
XL.Format.GetFont
Returns the font for this format.
All
  ✅ Server
XL.Format.GetHidden
Returns whether the hidden property is set to true.
All
  ✅ Server
XL.Format.GetIndent
Returns the text indentation level.
All
  ✅ Server
XL.Format.GetLocked
Returns whether the locked property is set to true.
All
  ✅ Server
XL.Format.GetNumFormat
Returns the number format identifier.
All
  ✅ Server
XL.Format.GetPatternBackgroundColor
Returns the background color of the fill pattern.
All
  ✅ Server
XL.Format.GetPatternForegroundColor
Returns the foreground color of the fill pattern.
All
  ✅ Server
XL.Format.GetRotation
Returns the text rotation.
All
  ✅ Server
XL.Format.GetShrinkToFit
Returns whether the cell is shrink-to-fit.
All
  ✅ Server
XL.Format.GetWrap
Returns whether the cell text is wrapped.
All
  ✅ Server
XL.Format.SetAlignH
Sets the horizontal alignment.
All
  ✅ Server
XL.Format.SetAlignV
Sets the vertical alignment.
All
  ✅ Server
XL.Format.SetBorder
Sets the border style.
All
  ✅ Server
XL.Format.SetBorderBottom
Sets the bottom border style.
All
  ✅ Server
XL.Format.SetBorderBottomColor
Sets the color of the bottom border.
All
  ✅ Server
XL.Format.SetBorderColor
Sets the border color.
All
  ✅ Server
XL.Format.SetBorderDiagonal
Sets the diagonal border.
All
  ✅ Server
XL.Format.SetBorderDiagonalColor
Sets the color of the diagonal border.
All
  ✅ Server
XL.Format.SetBorderDiagonalStyle
Sets the style for diagonal border.
All
  ✅ Server
XL.Format.SetBorderLeft
Sets the left border style.
All
  ✅ Server
XL.Format.SetBorderLeftColor
Sets the color of the left border.
All
  ✅ Server
XL.Format.SetBorderRight
Sets the right border style.
All
  ✅ Server
XL.Format.SetBorderRightColor
Sets the color of the right border.
All
  ✅ Server
XL.Format.SetBorderTop
Sets the top border style.
All
  ✅ Server
XL.Format.SetBorderTopColor
Sets the color of the top border.
All
  ✅ Server
XL.Format.SetFillPattern
Sets the fill pattern.
All
  ✅ Server
XL.Format.SetFont
Sets the font for the format.
All
  ✅ Server
XL.Format.SetHidden
Sets the hidden property.
All
  ✅ Server
XL.Format.SetIndent
Sets the text indentation level.
All
  ✅ Server
XL.Format.SetLocked
Sets the locked property.
All
  ✅ Server
XL.Format.SetNumFormat
Sets the number format identifier.
All
  ✅ Server
XL.Format.SetPatternBackgroundColor
Sets the background color of the fill pattern.
All
  ✅ Server
XL.Format.SetPatternForegroundColor
Sets the foreground color of the fill pattern.
All
  ✅ Server
XL.Format.SetRotation
Sets the text rotation.
All
  ✅ Server
XL.Format.SetShrinkToFit
Sets the flag whether the cell is shrink-to-fit.
All
  ✅ Server
XL.Format.SetWrap
Sets the flag whether the cell text is wrapped.
All
  ✅ Server
XL.Sheet.AddrToRowCol
Converts a cell reference to row and column.
All
  ✅ Server
XL.Sheet.CellIsDate
Checks that cell contains a date or time value.
All
  ✅ Server
XL.Sheet.CellIsFormula
Checks that cell contains a formula.
All
  ✅ Server
XL.Sheet.CellReadBlank
Checks if cell is blank.
All
  ✅ Server
XL.Sheet.CellReadBoolean
Reads a boolean value from a cell.
All
  ✅ Server
XL.Sheet.CellReadComment
Reads a comment value from a cell.
All
  ✅ Server
XL.Sheet.CellReadFormula
Reads the formula value from a cell.
All
  ✅ Server
XL.Sheet.CellReadNumber
Reads a number value from a cell.
All
  ✅ Server
XL.Sheet.CellReadText
Reads a text value from a cell.
All
  ✅ Server
XL.Sheet.CellType
Queries type of cell.
All
  ✅ Server
XL.Sheet.CellWriteBlank
Writes a blank cell.
All
  ✅ Server
XL.Sheet.CellWriteBoolean
Writes a boolean value into cell.
All
  ✅ Server
XL.Sheet.CellWriteComment
Writes a comment to a cell.
All
  ✅ Server
XL.Sheet.CellWriteFormula
Writes a formula into cell.
All
  ✅ Server
XL.Sheet.CellWriteNumber
Writes a number into cell.
All
  ✅ Server
XL.Sheet.CellWriteText
Writes a string into cell.
All
  ✅ Server
XL.Sheet.Clear
Clears cells in specified area.
All
  ✅ Server
XL.Sheet.ClearPrintArea
Clears the print area.
All
  ✅ Server
XL.Sheet.ClearPrintRepeats
Clears repeated rows and columns on each page.
All
  ✅ Server
XL.Sheet.CopyCell
Copies cell with format from (rowSrc, colSrc) to (rowDst, colDst).
All
  ✅ Server
XL.Sheet.DeleteMerge
Removes merged cells.
All
  ✅ Server
XL.Sheet.DeleteNamedRange
Deletes the named range by name.
All
  ✅ Server
XL.Sheet.GetCellError
Reads error from cell.
All
  ✅ Server
XL.Sheet.GetCellFormat
Returns cell's format.
All
  ✅ Server
XL.Sheet.GetColHidden
Returns whether column is hidden.
All
  ✅ Server
XL.Sheet.GetColWidth
Returns column width in points.
All
  ✅ Server
XL.Sheet.GetDisplayGridlines
Returns whether the gridlines are displayed.
All
  ✅ Server
XL.Sheet.GetFirstCol
Returns the first column in the sheet that contains a used cell.
All
  ✅ Server
XL.Sheet.GetFirstRow
Returns the first row in the sheet that contains a used cell.
All
  ✅ Server
XL.Sheet.GetFooter
Returns the footer text of the sheet when printed.
All
  ✅ Server
XL.Sheet.GetFooterMargin
Returns the footer margin in inches.
All
  ✅ Server
XL.Sheet.GetGroupSummaryBelow
Returns whether grouping rows summary is below.
All
  ✅ Server
XL.Sheet.GetGroupSummaryRight
Returns whether grouping columns summary is right.
All
  ✅ Server
XL.Sheet.GetHCenter
Returns whether the sheet is centered horizontally when printed.
All
  ✅ Server
XL.Sheet.GetHeader
Returns the header text of the sheet when printed.
All
  ✅ Server
XL.Sheet.GetHeaderMargin
Returns the header margin in inches.
All
  ✅ Server
XL.Sheet.GetHidden
Returns whether sheet is hidden.
All
  ✅ Server
XL.Sheet.GetHorPageBreak
Returns row with horizontal page break at position index.
All
  ✅ Server
XL.Sheet.GetHorPageBreakCount
Returns a number of horizontal page breaks in the sheet.
All
  ✅ Server
XL.Sheet.GetLandscape
Returns a page orientation mode.
All
  ✅ Server
XL.Sheet.GetLastCol
Returns the zero-based index of the column after the last column in the sheet that contains a used cell.
All
  ✅ Server
XL.Sheet.GetLastRow
Returns the zero-based index of the row after the last row in the sheet that contains a used cell.
All
  ✅ Server
XL.Sheet.GetMarginBottom
Returns the bottom margin of the sheet in inches.
All
  ✅ Server
XL.Sheet.GetMarginLeft
Returns the left margin of the sheet in inches.
All
  ✅ Server
XL.Sheet.GetMarginRight
Returns the right margin of the sheet in inches.
All
  ✅ Server
XL.Sheet.GetMarginTop
Returns the top margin of the sheet in inches.
All
  ✅ Server
XL.Sheet.GetMerge
Gets merged cells for cell at row, col.
All
  ✅ Server
XL.Sheet.GetName
Returns the name of the sheet.
All
  ✅ Server
XL.Sheet.GetNamedRange
Gets the named range coordianates by name.
All
  ✅ Server
XL.Sheet.GetPaper
Returns the paper size.
All
  ✅ Server
XL.Sheet.GetPicture
Returns a workbook picture index at position index in worksheet.
All
  ✅ Server
XL.Sheet.GetPrintFit
Returns whether fit to page option is enabled.
All
  ✅ Server
XL.Sheet.GetPrintGridlines
Returns whether the gridlines are printed.
All
  ✅ Server
XL.Sheet.GetPrintRow
Returns whether the row and column headers are printed.
All
  ✅ Server
XL.Sheet.GetPrintZoom
Returns the scaling factor for printing as a percentage.
All
  ✅ Server
XL.Sheet.GetProtect
Returns whether sheet is protected.
All
  ✅ Server
XL.Sheet.GetRowHeight
Returns row height in points.
All
  ✅ Server
XL.Sheet.GetRowHidden
Returns whether row is hidden.
All
  ✅ Server
XL.Sheet.GetText
Queries the text of a sheet in a workbook.
All
  ✅ Server
XL.Sheet.GetTopLeftView
Extracts the first visible row and the leftmost visible column of the sheet.
All
  ✅ Server
XL.Sheet.GetVCenter
Returns whether the sheet is centered vertically when printed.
All
  ✅ Server
XL.Sheet.GetVerPageBreak
Returns column with vertical page break at position index.
All
  ✅ Server
XL.Sheet.GetVerPageBreakCount
Returns a number of vertical page breaks in the sheet.
All
  ✅ Server
XL.Sheet.GetZoom
Returns the zoom level of the current view as a percentage.
All
  ✅ Server
XL.Sheet.GroupCols
Groups columns from colFirst to colLast.
All
  ✅ Server
XL.Sheet.GroupRows
Groups rows from rowFirst to rowLast.
All
  ✅ Server
XL.Sheet.InsertCol
Inserts columns from colFirst to colLast.
All
  ✅ Server
XL.Sheet.InsertRow
Inserts rows from rowFirst to rowLast.
All
  ✅ Server
XL.Sheet.NamedRange
Gets the named range coordinates by index.
All
  ✅ Server
XL.Sheet.NamedRangeCount
Returns the number of named ranges in the sheet.
All
  ✅ Server
XL.Sheet.PictureCount
Returns a number of pictures in this worksheet.
All
  ✅ Server
XL.Sheet.RemoveCol
Removes columns from colFirst to colLast.
All
  ✅ Server
XL.Sheet.RemoveRow
Removes rows from rowFirst to rowLast.
All
  ✅ Server
XL.Sheet.RowColToAddr
Converts row and column to a cell reference.
All
  ✅ Server
XL.Sheet.SetCellFormat
Sets cell's format.
All
  ✅ Server
XL.Sheet.SetCol
Sets column width and format for all columns from colFirst to colLast.
All
  ✅ Server
XL.Sheet.SetColHidden
Hides or shows a column.
All
  ✅ Server
XL.Sheet.SetColumn
Sets column width and format for all columns from colFirst to colLast.
All
  ✅ Server
XL.Sheet.SetDisplayGridlines
Sets gridlines for displaying.
All
  ✅ Server
XL.Sheet.SetFooter
Sets the footer text for the sheet when printed.
All
  ✅ Server
XL.Sheet.SetGroupSummaryBelow
Sets a flag of grouping rows summary.
All
  ✅ Server
XL.Sheet.SetGroupSummaryRight
Sets a flag of grouping rows summary.
All
  ✅ Server
XL.Sheet.SetHCenter
Sets a flag that the sheet is centered horizontally when printed.
All
  ✅ Server
XL.Sheet.SetHeader
Sets the header text of the sheet when printed.
All
  ✅ Server
XL.Sheet.SetHorPageBreak
Sets/removes a horizontal page break.
All
  ✅ Server
XL.Sheet.SetLandscape
Sets landscape or portrait mode for printing.
All
  ✅ Server
XL.Sheet.SetMarginBottom
Sets the bottom margin of the sheet in inches.
All
  ✅ Server
XL.Sheet.SetMarginLeft
Sets the left margin of the sheet in inches.
All
  ✅ Server
XL.Sheet.SetMarginRight
Sets the right margin of the sheet in inches.
All
  ✅ Server
XL.Sheet.SetMarginTop
Sets the top margin of the sheet in inches.
All
  ✅ Server
XL.Sheet.SetMerge
Sets merged cells for range: rowFirst - rowLast, colFirst - colLast.
All
  ✅ Server
XL.Sheet.SetName
Sets the name of the sheet.
All
  ✅ Server
XL.Sheet.SetNamedRange
Sets the named range.
All
  ✅ Server
XL.Sheet.SetPaper
Sets the paper size.
All
  ✅ Server
XL.Sheet.SetPictureWithScale
Sets a picture with pictureId identifier at position row and col with scale factor and offsets in pixels.
All
  ✅ Server
XL.Sheet.SetPictureWithSize
Sets a picture with pictureId identifier at position row and col with custom size and offsets in pixels.
All
  ✅ Server
XL.Sheet.SetPrintArea
Sets the print area.
All
  ✅ Server
XL.Sheet.SetPrintFit
Fits sheet width and sheet height to wPages and hPages respectively.
All
  ✅ Server
XL.Sheet.SetPrintGridlines
Sets gridlines for printing.
All
  ✅ Server
XL.Sheet.SetPrintRepeatCols
Sets repeated columns on each page from colFirst to colLast.
All
  ✅ Server
XL.Sheet.SetPrintRepeatRows
Sets repeated rows on each page from rowFirst to rowLast.
All
  ✅ Server
XL.Sheet.SetPrintRow
Sets a flag that the row and column headers are printed.
All
  ✅ Server
XL.Sheet.SetPrintZoom
Sets the scaling factor for printing as a percentage.
All
  ✅ Server
XL.Sheet.SetProtect
Protects/unprotects the sheet.
All
  ✅ Server
XL.Sheet.SetRow
Sets row height and format.
All
  ✅ Server
XL.Sheet.SetRowHidden
Hides or shows a row.
All
  ✅ Server
XL.Sheet.SetTopLeftView
Sets the first visible row and the leftmost visible column of the sheet.
All
  ✅ Server
XL.Sheet.SetVCenter
ets a flag that the sheet is centered vertically when printed.
All
  ✅ Server
XL.Sheet.SetVerPageBreak
Sets/removes a vertical page break.
All
  ✅ Server
XL.Sheet.SetZoom
Sets the zoom level of the current view.
All
  ✅ Server
XL.Sheet.Split
Splits a sheet at position (row, col).
All
  ✅ Server

417 functions shown.

These functions require a license (87%).

Blog Entries

Older Version 3.4   Newer Version 4.0