InformationLinkParameter Class

[SerializableAttribute]
[PersistenceVersionAttribute(6, 0)]
public sealed class InformationLinkParameter : ISerializable

The InformationLinkParameter type exposes the following members.

	Name	Description
	DataType	Obsolete. Gets the parameter data type.
	ElementId	Obsolete. Gets the identifier for the element (column or procedure) in the information link that this parameter applies to.
	ElementIdentifier	Gets the identifier for the element (column or procedure) in the information link that this parameter applies to.
	Expression	Gets the expression for a filter parameter.
	ExternalDataType	Gets the parameter data type.
	ParameterId	Gets a parameter identifier local for the current element (see ElementIdentifier).
	Values	Gets the parameter values.

	Name	Description
	CreateFilterParameter(Guid, String, Object)	Creates a new InformationLinkParameter representing a filter parameter.
	CreateFilterParameter(String, String, Object)	Obsolete. Creates a new InformationLinkParameter representing a filter parameter.
	CreateFilterParameter(Guid, String, Object, ExternalDataType)	Creates a new InformationLinkParameter representing a filter parameter.
	CreateFilterParameter(String, String, Object, String)	Obsolete. Creates a new InformationLinkParameter representing a filter parameter.
	CreateNamedParameter	Creates a new InformationLinkParameter that represents a named parameter defined in the information model.
	CreateReferencedParameter(Guid, String, Object)	Creates a new InformationLinkParameter that represents a local parameter defined in the specified procedure element.
	CreateReferencedParameter(String, String, Object)	Obsolete. Creates a new InformationLinkParameter that represents a local parameter defined in the specified procedure element.
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

	Name	Description
	ISerializableGetObjectData	Populates a SerializationInfo with the data needed to serialize the target object.

A named parameter points to a predefined named parameter in an information link. The parameter name is identified by the ParameterId property. Named parameters may also be passed in a configuration block when opening an analysis. Including a named parameter in the InformationLinkDataSource constructor will override any parameter with the same name passed in a configuration block. For information on how to set up named parameters in an information link see the 'Parameterized Information Link' topic in Spotfire - User's Manual.

A filter parameter adds a filter to a column in an information link. The column is identified by the ElementId property. The filter is defined by the Expression property, which is essentially a SQL expression with placeholders for the column identifier and parameter values:

• %Column% - Placeholder for a source column identifier. The placeholder may occur one or several times in the expression, for example "%Column% in ... or %Column% = ...".
• %Values% - Placeholder for the parameter values as a list, for example "%Column% in (%Values%)".
• %Value[n]%, where n=0,1,.. - Placeholder for one of the parameter values, for example "%Column% between %Values[0]% and %Values[1]%".
• %Value% - Short for %Value[0]%. Placeholder for a single parameter value, for example "%Column% <= %Value%".

A referenced parameter represents a procedure parameter. The procedure is identified by the ElementId property and the parameter name is identified by the ParameterId property.

• String - Representation type: System.String
• Integer - Representation type: System.Int32
• Real - Representation type: System.Double
• Date - Representation type: System.DateTime
• Time - Representation type: System.DateTime
• DateTime - Representation type: System.DateTime
• Clob - Representation type: System.String
• Blob - Representation type: System.byte[]

Reference