AnalysisApplication.SaveToLibrary Method (String, String, String, String, Boolean, DocumentSaveSettings)

AnalysisApplication SaveToLibrary Method (String, String, String, String, Boolean, DocumentSaveSettings)

TIBCO Spotfire 6.5 API Reference

Saves the current document in the TIBCO Spotfire Server Library and overwrites an existing document if necessary.

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

Syntax

C++

Copy to Clipboard Print

[ObsoleteAttribute("Use Save() or SaveAs(LibraryItem, ...) instead.")]
public virtual bool SaveToLibrary(
	string path,
	string name,
	string description,
	string keywords,
	bool overwrite,
	DocumentSaveSettings settings
)

[ObsoleteAttribute("Use Save() or SaveAs(LibraryItem, ...) instead.")]
public virtual bool SaveToLibrary(
	string path,
	string name,
	string description,
	string keywords,
	bool overwrite,
	DocumentSaveSettings settings
)

Parameters

path: Type: System String
The parent path in which the file shall be created. The parent type must be a Section or a Folder.

name: Type: System String
The name of the document to store in the library. Must be a name that is unique for an Analysis file with the given path.

description: Type: System String
A brief description of the analysis.

keywords: Type: System String
Searchable keywords for the analysis.

overwrite: Type: System Boolean
true to overwrite existing an existing document if necessary. false to throw if an existing document with the given path and name already exists.

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: Boolean
true if the document was successfully saved.

Exceptions

Exception	Condition
System InvalidOperationException	This method is not called from the application main thread.
System ArgumentNullException	any of the parameters are null.
System ArgumentException	name is an empty string.
Spotfire.Dxp.Framework.Library LibraryException	there exists an Analysis document with the same name at the same path in the Library. -or- the path is not a valid folder or section. -or- the name is greater than 50 characters or contains invalid characters. -or- there exist a library entry with the given name and overwrite is not enabled. -or- a communication error occurs when saving the document in the Library.
System NotSupportedException	This method is called in the Spotfire Web Player.

Remarks

This operation is not executed with progress, that is, no progress dialog is shown while the current document is being uploaded and saved in the library.

This method is not supported in the Spotfire Web Player. Calling it there will cause a NotSupportedException to be thrown.

Version Information

Obsolete (compiler warning) in 6.5
Obsolete (compiler warning) in 6.0
Obsolete (compiler warning) in 5.5
Obsolete (compiler warning) in 5.0
Obsolete (compiler warning) in 4.5