AnalysisApplication.SaveToLibrary Method (Guid, DocumentSaveSettings)

AnalysisApplication SaveToLibrary Method (Guid, DocumentSaveSettings)

TIBCO Spotfire 6.0 API Reference

Saves the current document in the TIBCO Spotfire Server Library and overwrites an existing document. This operation can only be used to overwrite an already existing document in the library.

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

Syntax

C++

Copy to Clipboard Print

[ObsoleteAttribute("Use Save() or SaveAs(LibraryItem, ...) instead.")]
public virtual bool SaveToLibrary(
	Guid entryId,
	DocumentSaveSettings settings
)

[ObsoleteAttribute("Use Save() or SaveAs(LibraryItem, ...) instead.")]
public virtual bool SaveToLibrary(
	Guid entryId,
	DocumentSaveSettings settings
)

Parameters

entryId: Type: System Guid
The unique id of the entry to overwrite.

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 or if no document is loaded in the application.
System ArgumentNullException	settings is null.
System ArgumentException	entryId is an empty GUID or no entry with this value exists in the library.
Spotfire.Dxp.Framework.Library LibraryException	if 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.