RowsOutput Class

Spotfire 14.3 API Reference

Represents the settings for the handling of a OutputParameter of a DataFunction. This class will add rows to an existing table when first executed and when updated it will either update those rows or add new rows depending on the settings.

Inheritance Hierarchy

SystemObject
  Node
    Spotfire.Dxp.Framework.DocumentModelDocumentNode
      Spotfire.Dxp.Data.DataFunctionsDataFunctionOutput
        Spotfire.Dxp.Data.DataFunctionsRowsOutput

Namespace: Spotfire.Dxp.Data.DataFunctions
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 RowsOutput : DataFunctionOutput

The RowsOutput type exposes the following members.

Properties

	Name	Description
	Context	Gets the context of this node. (Inherited from DocumentNode.)
	DataTableReference	Gets the table reference of the table to add rows to.
	IgnoredColumns	Gets the columns not included in the mapping or the additional columns from the output that should be ignored.
	InputToAdaptSelectionFrom	Gets the input whose selections should be used to map output rows back into the application. (Inherited from DataFunctionOutput.)
	IsAttached	Gets a value indicating whether this node is attached. (Inherited from DocumentNode.)
	Map	Gets a map matching columns from the original table to columns in the output.
	NewRowSourceValue	Gets the value that new elements in the row source column should get.
	OriginalRowSourceValue	Gets the value that the existing elements in the row source column should get.
	ReplaceRowsWhenUpdating	Gets a value indicating whether the rows produced the first time should be replaced when executing a second time. If false the old rows will become embedded and the new rows added.
	RowSourceColumn	Gets the column in the table that will be created to indicate the source of the rows..
	Transactions	Gets a collection of methods for executing transactions on the document. (Inherited from DocumentNode.)
	Transformations	Gets the transformations for this output mapping. (Inherited from DataFunctionOutput.)

Top

Methods

	Name	Description
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Explicit Interface Implementations

	Name	Description
	INodeContextGetAncestorT	Implements GetAncestorT. (Inherited from DocumentNode.)
	INodeContextGetServiceT	Implements GetServiceT. (Inherited from DocumentNode.)
	INodeContextIsDescendantOf	Implements IsDescendantOf(DocumentNode). (Inherited from DocumentNode.)
	ITransactionsBeginAggregatedTransaction	Implements BeginAggregatedTransaction. (Inherited from DocumentNode.)
	ITransactionsExecuteInvisibleTransaction	Implements ExecuteInvisibleTransaction(Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteInvisibleTransaction2	Implements ExecuteInvisibleTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactionsExecuteStickyTransaction	Implements ExecuteStickyTransaction(Guid, Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteStickyTransaction2	Implements ExecuteStickyTransaction(Guid, Executor) for the Action Mods API. (Inherited from DocumentNode.)
	ITransactionsExecuteTransaction	Implements ExecuteTransaction(Executor). (Inherited from DocumentNode.)
	ITransactionsExecuteTransaction2	Implements ExecuteTransaction(Executor) for the Action Mods API. (Inherited from DocumentNode.)

Top

Remarks

Instance of this class is created in the DataFunctionOutputCollection.

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.DataFunctions Namespace

Spotfire.Dxp.Data.DataFunctionsRowsOutputBuilder