SaveLayoutItemCustomFrameFiles() function - MapBasic - 2023

MapInfo MapBasic Reference

Product type
Software
Portfolio
Locate
Product family
MapInfo
Product
MapInfo > MapBasic
Version
2023
Language
English
Product name
MapBasic
Title
MapInfo MapBasic Reference
First publish date
1985
Last updated
2023-09-12
Published on
2023-09-12T16:32:32.686312

Purpose

This function saves custom frame files (*.mlcf and *.xps) for a for a Layout window to a given location. You can call this function from the MapBasic window in MapInfo Pro.

Syntax

SaveLayoutItemCustomFrameFiles( window_id, page_num frame_id, path)

window_id is an integer window identifier for a Layout window.

page_num is the page number on which to query for a frame id. Use numbers from 1 to n where n is the number of pages in the layout.

frame_id is a number that specifies which frame within a Layout window you want to query. Frames are numbered 1 to n where n is the number of frames in the layout.

path is a string that specifies the path to where custom frame files are saved.

Return Value

Logical

This function returns TRUE on success. Otherwise, it returns FALSE.

Description

This function save the *.mlcf and *.xps files related to custom frames to a given directory path.