Saver Object

Contains:

Objects:

• Elements (read-only).
• MetaData (read-only).

Properties:

• Title - name to save the page to Inquiry.
• Comment - page comment. If it is not defined by the user or plugin, Inquiry takes it from the META DESCRIPTION tag.
• KeyWords - page keywords. If it is not defined by the user or plugin, Inquiry takes it from the META KEYWORDS tag.
• PageIcon - icon, associated with the page. Possible values: Standard, Custom, Important, Review, Do not delete, Reference, Live, News, Favorite, Article, Company, Financial, Usergroup, Special, Shared, Private, Personal, High Priority, Low Priority, Questionable.
• IsUserTitle, IsUserComment, IsUserKeyWords, IsUserPageIcon (read-only) - if any of them is true, then the corresponding value was set by the user and plugin cannot change it.
• IsUserFolder (read-only) - user selected the folder to save and it cannot be changed.
• IsUserUpdate (read-only) - Inquiry updates the page by the user request and plugin canot use TargetFolder and ReplacePage functions.
• IsUpdate (read-only) - Inquiry updates the page (user-requested or from plugin).
• IsSelection (read-only) - Inquiry saves selection only, not the whole page.
• IsAutoSave (read-only) - Inquiry saves the page to AutoSaved. You can save there from plugin using IQ.Saver.TargetFolder = IQ.CurrentAutoSaved();
• TargetFolder - returns folder where the page is being saved. You can change this value.

Functions:

• StopSave (without parameters) - cancel saving the page. Nothing will be saved.
• ReplacePage (page) - update previously saved page with this one instead of saving a new one. When you call this function, the objects Elements, MetaData and properties Title, Comment, KeyWords, PageIcon will be replaced by the same from the page you are about to replace.

Example:
//Replace the first page from the 'Saved Pages' folder.
fld = IQ.SavedPages;
page = fld.FirstChildPage();
if (page)
IQ.Saver.ReplacePage(page);