ColumnsOutput Class

Spotfire 14.2 API Reference
Represents the settings for the handling of a OutputParameter of a DataFunction. This class will add columns to an existing table when first executed and when updated it will either update those column or add new columns depending on the settings.
Inheritance Hierarchy

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

Namespace:  Spotfire.Dxp.Data.DataFunctions
Assembly:  Spotfire.Dxp.Data (in Spotfire.Dxp.Data.dll) Version: 64.0.19329.3263 (64.0.19329.3263)
Syntax

C#
[SerializableAttribute]
[PersistenceVersionAttribute(6, 0)]
public sealed class ColumnsOutput : DataFunctionOutput

The ColumnsOutput type exposes the following members.

Properties

  NameDescription
Public propertyAddNewColumnsWhenUpdating
Gets a value indicating whether the columns produced the first time should be replaced when executing a second time. If false the old columns will become embedded and the new rows added.
Public propertyContext
Gets the context of this node.
(Inherited from DocumentNode.)
Public propertyDataTableReference
Gets the reference to table where the columns are added.
Public propertyInputToAdaptSelectionFrom
Gets the input whose selections should be used to map output rows back into the application.
(Inherited from DataFunctionOutput.)
Public propertyIsAttached
Gets a value indicating whether this node is attached.
(Inherited from DocumentNode.)
Public propertyResultColumns
Gets the columns created by this output.
Public propertyTransactions
Gets a collection of methods for executing transactions on the document.
(Inherited from DocumentNode.)
Public propertyTransformations
Gets the transformations for this output mapping.
(Inherited from DataFunctionOutput.)
Top
Methods

  NameDescription
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Explicit Interface Implementations

  NameDescription
Explicit interface implementationPrivate methodINodeContextGetAncestorT (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContextGetServiceT (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodINodeContextIsDescendantOf (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsBeginAggregatedTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteInvisibleTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteInvisibleTransaction2
Implements ExecuteInvisibleTransaction(Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteStickyTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteStickyTransaction2
Implements ExecuteStickyTransaction(Guid, Executor) for the Action Mods API.
(Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteTransaction (Inherited from DocumentNode.)
Explicit interface implementationPrivate methodITransactionsExecuteTransaction2
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.2, 14.1, 14.0, 12.5, 12.4, 12.3, 12.2, 12.1, 12.0, 11.8, 11.7, 11.6, 11.5, 11.4
See Also

Reference