AnalysisApplicationSaveToLibrary Method (String, String, String, String, Boolean, DocumentSaveSettings)

 Spotfire 14.3 API Reference

Note: This API is now obsolete.

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

Namespace:  Spotfire.Dxp.Application
Assembly:  Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 65.0.19510.3242 (65.0.19510.3242)
Syntax
C#
Copy
[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: SystemString
The parent path in which the file shall be created. The parent type must be a Section or a Folder.
name
Type: SystemString
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: SystemString
A brief description of the analysis.
keywords
Type: SystemString
Searchable keywords for the analysis.
overwrite
Type: SystemBoolean
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.ApplicationDocumentSaveSettings
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
ExceptionCondition
InvalidOperationException This method is not called from the application main thread.
ArgumentNullException any of the parameters are null.
ArgumentExceptionname is an empty string.
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.
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 14.3
Obsolete (compiler warning) in 14.2
Obsolete (compiler warning) in 14.1
Obsolete (compiler warning) in 14.0
Obsolete (compiler warning) in 12.5
Obsolete (compiler warning) in 12.4
Obsolete (compiler warning) in 12.3
Obsolete (compiler warning) in 12.2
Obsolete (compiler warning) in 12.1
Obsolete (compiler warning) in 12.0
Obsolete (compiler warning) in 11.8
See Also

Reference

AnalysisApplication Class
SaveToLibrary Overload
Spotfire.Dxp.Application Namespace