InformationLinkDataSource Properties

Spotfire 14.3 API Reference

The InformationLinkDataSource type exposes the following members.

Properties

  NameDescription
Public propertyDocumentTitle
Gets a document title for the data returned from this data source with the current configuration.
(Overrides DataSourceDocumentTitle.)
Public propertyId
Gets or sets the id of a referenced information link stored on the server.
Public propertyInformationLinkId Obsolete.
Gets or sets the id of a referenced information link stored on the server.
Public propertyIsLinkable
Returns true to indicate that this instance supports linked data mode.
(Overrides DataSourceIsLinkable.)
Public propertyIsPromptingAllowed
Gets or sets a value indicating whether prompting is allowed is allowed for this data source instance.
(Inherited from DataSource.)
Public propertyLoadReport
Gets the PartialDataLoadReport that can be used to report errors during connection.
(Inherited from DataSource.)
Public propertyName
Gets the display name of the data source. Same as the document title by default.
(Inherited from DataSource.)
Public propertyParameters
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
null
.
Public propertyReuseSettingsWithoutPrompting
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.)
Public propertyTypeId
Gets the type identifier for the data source.
(Inherited from DataSource.)
Top
See Also

Reference