AnalysisApplication.SaveAs Method (LibraryItem, String, LibraryItemMetadataSettings, DocumentSaveSettings)

AnalysisApplication SaveAs Method (LibraryItem, String, LibraryItemMetadataSettings, DocumentSaveSettings)

TIBCO Spotfire 7.0 API Reference

Saves the currently loaded document to the library with the specified title in the specified folder.

Namespace: Spotfire.Dxp.Application
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 18.10.8513.5432 (18.10.8513.5432)

Syntax

C++

Copy to Clipboard Print

public LibraryItem SaveAs(
	LibraryItem folder,
	string title,
	LibraryItemMetadataSettings metadataSettings,
	DocumentSaveSettings settings
)

public LibraryItem SaveAs(
	LibraryItem folder,
	string title,
	LibraryItemMetadataSettings metadataSettings,
	DocumentSaveSettings settings
)

Parameters

folder: Type: Spotfire.Dxp.Framework.Library LibraryItem
The library folder in which to save the document.

title: Type: System String
The title of the library item that the document will be saved to.

metadataSettings: Type: Spotfire.Dxp.Framework.Library LibraryItemMetadataSettings
The metadata to associate with the library item.

settings: Type: Spotfire.Dxp.Application DocumentSaveSettings
Controls some aspects of how the document is saved. For instance whether a configuration block is embedded.

Return Value

Type: LibraryItem

Exceptions

Exception	Condition
Spotfire.Dxp.Framework.Library LibraryException	If there are any issues in accessing the library.

Remarks

This method will overwrite an existing item but keep the existing library item id.

Version Information

Supported in: 7.0, 6.5, 6.0, 5.5, 5.0