InformationLinkDataSource Class

Spotfire 14.3 API Reference

Data source for information links.

Inheritance Hierarchy

SystemObject
Spotfire.Dxp.DataDataSource
Spotfire.Dxp.Data.ImportInformationLinkDataSource

Namespace: Spotfire.Dxp.Data.Import
Assembly: Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll) Version: 65.0.19510.3242 (65.0.19510.3242)

Syntax

Copy

[SerializableAttribute]
[PersistenceVersionAttribute(6, 0)]
public sealed class InformationLinkDataSource : DataSource

The InformationLinkDataSource type exposes the following members.

Constructors

	Name	Description
	InformationLinkDataSource	Initializes a new instance of the InformationLinkDataSource class.
	InformationLinkDataSource(Guid)	Initializes a new instance of the InformationLinkDataSource class.
	InformationLinkDataSource(String)	Obsolete. Initializes a new instance of the InformationLinkDataSource class.
	InformationLinkDataSource(LibraryItem)	Initializes a new instance of the InformationLinkDataSource class.
	InformationLinkDataSource(Guid, IEnumerableInformationLinkParameter)	Initializes a new instance of the InformationLinkDataSource class.
	InformationLinkDataSource(String, IListInformationLinkParameter)	Obsolete. Initializes a new instance of the InformationLinkDataSource class.
	InformationLinkDataSource(Guid, IEnumerableInformationLinkParameter, String)	Initializes a new instance of the InformationLinkDataSource class.
	InformationLinkDataSource(String, IListInformationLinkParameter, String)	Obsolete. Initializes a new instance of the InformationLinkDataSource class.

Top

Properties

	Name	Description
	DocumentTitle	Gets a document title for the data returned from this data source with the current configuration. (Overrides DataSourceDocumentTitle.)
	Id	Gets or sets the id of a referenced information link stored on the server.
	InformationLinkId	Obsolete. Gets or sets the id of a referenced information link stored on the server.
	IsLinkable	Returns true to indicate that this instance supports linked data mode. (Overrides DataSourceIsLinkable.)
	IsPromptingAllowed	Gets or sets a value indicating whether prompting is allowed is allowed for this data source instance. (Inherited from DataSource.)
	LoadReport	Gets the PartialDataLoadReport that can be used to report errors during connection. (Inherited from DataSource.)
	Name	Gets the display name of the data source. Same as the document title by default. (Inherited from DataSource.)
	Parameters	Gets or sets a list of parameters that are applied when executing the information link. Parameters for elements that are not included in the information link will be ignored. If prompting is enabled a parameter is used as default value in a prompt step if the target element is the same. If prompting is not enabled, the parameters will be applied unchanged, unless prompt values were saved in the document previously. Parameters for elements not included in any prompt steps are applied unchanged (also in the prompt steps). The parameters are persisted with the data source when saving an analysis, and are re-applied when opening the same analysis. See InformationLinkParameter for a description on how to create a parameter. This argument is optional and may be set to Copy null .
	ReuseSettingsWithoutPrompting	Gets or sets a value indicating whether settings should be reused without prompting or not. Determines if the data source should be opened in silent mode, prompting the user only when necessary, or if the user should get a chance to modify the settings even if they are valid. (Inherited from DataSource.)
	TypeId	Gets the type identifier for the data source. (Inherited from DataSource.)

Top

Methods

	Name	Description
	BrowseForInformationLink	Lets the user browse or search for an information link.
	Connect	Creates a DataSourceConnection, using the specified serviceProvider and the settings in this data source instance. If needed, and allowed by the current prompt mode, the user may be prompted for additional settings. (Inherited from DataSource.)
	ConnectWithDelayedPrompting	Creates a DataSourceConnection, using the specified serviceProvider and the settings in this data source instance. If needed, and allowed by the current prompt mode, the user may be prompted for additional settings. (Inherited from DataSource.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	FindAll	Call this method with a search expression to get a collection of InformationLinkDescriptors matching the expression.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetInformationLinkDescriptor(Guid)	Get an InformationLinkDescriptor corresponding to given identifier.
	GetInformationLinkDescriptor(String)	Obsolete. Get an InformationLinkDescriptor corresponding to given identifier.
	GetObjectData	Populates a SerializationInfo with the data needed to serialize the target object. (Overrides DataSourceGetObjectData(SerializationInfo, StreamingContext).)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Version Information

Supported in: 14.3, 14.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8

Reference

Spotfire.Dxp.Data.Import Namespace