A Sandcastle Documented Class Library

# Transform Class

The base class for transform nodes.
Inheritance Hierarchy
System
Object
Dundas.BI.Extensibility
ComponentBase
Dundas.BI.Data.Transforms
Transform
Dundas.BI.Data.Transforms
DataGeneratorTransform
Dundas.BI.Data.Transforms
PlaceholderTransform
Dundas.BI.Data.Transforms
ResultTransform

Namespace: Dundas.BI.Data.Transforms
Assembly: Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (10.0.0.1002)
Syntax
C#
VB
C++
F#
Copy

    public abstract class Transform : ComponentBase,
    	IDisposable, IDataWarnings

    Public MustInherit Class Transform
    	Inherits ComponentBase
    	Implements IDisposable, IDataWarnings

    public ref class Transform abstract : public ComponentBase,
    	IDisposable, IDataWarnings

    [<AbstractClassAttribute>]
    type Transform =
        class
            inherit ComponentBase
            interface IDisposable
            interface IDataWarnings
        end

The Transform type exposes the following members.

Constructors

| Name | Description
--- | --- | ---
| Transform | Initializes a new instance of the Transform class.

Top
Properties

| Name | Description
--- | --- | ---
| AdapterUIClassName | Gets a value indicating the name of the java script adapter class which is to be created for this transform.
| ComponentDescription | Gets the standard component description. (Inherited from ComponentBase.)
| ComponentId | Gets the component ID. (Inherited from ComponentBase.)
| ComponentName | Gets the standard component name. (Inherited from ComponentBase.)
| Description | Gets or sets the object description.
| ElementExpressions | Gets the element process expressions, if any are defined for the current transform.
| Entity | Gets the parent entity.
| HasCustomConfigurationUI | Gets a value indicating whether this transform is using a custom configuration UI.
| HasElementExpressions | Gets a value indicating whether this instance has element process expressions defined within.
| HasTransformExpressions | Gets a value indicating whether this instance has transform expressions defined within.
| HasWarnings | Gets a value indicating whether this instance has any warnings.
| HelpUri | Gets a URI to a web page which provides documentation about the transform.
| Id | Gets the object ID.
| Input | Gets the transform main input.
| Inputs | Gets the inputs.
| IsAvailableInToolbar | Gets a value indicating whether or not the transform will be available in the toolbar.
| IsClosureTransform | Gets a value indicating whether this instance is a closure transform.
| IsConfigured | Gets a value indicating whether this instance is configured properly. When overriding, always check the value on the base class first.
| IsDoubleWidthDialog | Gets a value indicating whether this transform requires a double width UI dialog.
| IsDynamicInputSupported | Gets a value indicating whether this instance supports a dynamic number of inputs When true, all dynamic inputs get their settings from the primary transform input.
| IsEnabled | Gets a value indicating whether the component is enabled. (Inherited from ComponentBase.)
| IsGroupRecordTransform | Gets a value indicating whether this instance processes multiple records at a time.
| IsInceptionTransform | Gets a value indicating whether this instance is an inception transform.
| IsInMemoryProcess | Gets a value indicating whether the current instance is executed as an in-memory process.
| IsInputConnectionValid | Gets a value indicating whether this instance has a valid input connection.
| IsMultipleElementTransform | Gets a value indicating whether this instance processes multiple elements at a time.
| IsOutputConnectionValid | Gets a value indicating whether this instance has a valid output connection.
| IsSingleElementTransform | Gets a value indicating whether this instance processes a single element at a time.
| IsSingleRecordTransform | Gets a value indicating whether this instance processes one record at a time.
| IsStepTransform | Gets a value indicating whether this instance is a process step transform.
| IsUnsafeQueryPrivilegeRequired | Gets a value indicating whether this instance requires unsafe query privileges.
| Logger | Gets the logger for the module or extension package corresponding to the component. (Inherited from ComponentBase.)
| Name | Gets or sets the object name.
| NodeIconUri | Gets a value indicating the relative path to be used as the transform's node icon when rendered on the canvas.
| Output | Gets the transform main output.
| PackageId | Gets the ID of the extension package to which the component belongs. (Inherited from ComponentBase.)
| Parameters | Gets all the parameters defined for the current instance. These are either expression parameters or native structure parameters, if the current instance is a SelectTransform .
| Process | Gets the parent DataProcess.
| ProcessingType | Gets the type of the processing.
| SettingValues | Gets the setting values for the current instance.
| SupportsOutputExpressions | Gets a value indicating whether this instance supports the definition of output connector elements based on ConnectorElementExpression.
| SupportsParameterizableOutputElements | Gets a value indicating whether the output elements for the current instance are parameterizable.
| SupportsTransformExpressions | Gets a value indicating whether the current transform supports TransformExpressions that define the current instance functionality.
| ToolbarIconUri | Gets a value indicating the relative path to be used as the transform's icon in the toolbar.
| TransformExpressions | Gets the transform expressions, if any are defined for the current transform.
| TransformSettings | Gets the transform generic settings.
| Warnings | Gets all the warnings currently associated with this instance.

Top
Methods

| Name | Description
--- | --- | ---
| AddDynamicInput | Adds one dynamic input to the current instance. The dynamic input always takes its element settings (if any) from the primary transform input. Dynamic inputs do not support transform settings.
| AddOutputExpression | Adds a new ExpressionDescriptor for an output connector element .
| AddTransformExpression | Adds a new TransformExpression for the current instance .
| AddWarning | Adds a data warning to the current instance.
| AppendTransformSettings | Appends the transform-specific settings that cannot be populated in GetMetadata(IList InputConnector , OutputConnector , IList ComponentSetting ), such as native parameters.
| ClearWarnings | Clears all data warnings from the current instance.
| ConfigureSetting(ParameterValue) | Configures a transform setting.
| ConfigureSetting(ConnectorElement, ParameterValue) | Configures an input element setting.
| ConfigureSetting(InputConnector, ParameterValue) | Configures transform input setting.
| Dispose | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
| Dispose(Boolean) | Releases unmanaged and - optionally - managed resources.
| FetchElementValue | Fetches the value for the specified output element for run time data retrieval.
| Finalize | Finalizes an instance of the Transform class. (Overrides Object Finalize .)
| FindConnectorElement(Guid) | Finds a connector element by its ID.
| FindConnectorElement(String) | Finds the connector element by native name.
| GenerateOutputElementSources | Generates the list of OutputElementSource, which are used elements for an OutputConnector.
| GenerateProviderTask | Generates a data provider task, in those cases when the transform may be compatible with specific provider categories, such as OLAP providers or relational data providers.
| GetConfigurationValue(Guid) | Gets the configuration value for a transform setting.
| GetConfigurationValue(ComponentSetting) | Gets the configuration value for a transform setting.
| GetConfigurationValue(ConnectorElement, Guid) | Gets the configuration value for an input connector element setting.
| GetConfigurationValue(InputConnector, Guid) | Gets the configuration value for a transform input setting.
| GetCustomConfigurationUI | Gets the custom configuration UI based on the requested content type.
| GetMetadata | Populates the process transform metadata by describing the data inputs, output and any available settings.
| GetParameterValue | Gets the specified transform parameter value.
| InitializeSettingsFromContract | Initialize setting values using values stored in a data contract.
| Localize | Localizes the specified string using the engine localization service. (Inherited from ComponentBase.)
| PreviewReader | Previews the output for the current instance.
| Read | Reads a single record for the transform output, if there are any. If there are no more output records, it returns . The base class implementation calls Read on all the input readers and return if at least one of these operations is successful. Transforms that process a single record at one time do not need to override the base class implementation. Transforms that process multiple records at one time need to override the base class implementation by retrieving the necessary input data and also performing output record processing. If the Read operation is successful, the transform is responsible for providing corresponding data values on subsequent FetchElementValue calls.
| Refresh | Updates the collection of output elements, evaluating all setting and parameter values.
| RemoveDynamicInput | Removes a previously defined dynamic input.
| RemoveOutputExpression | Removes a process expression previously defined for an output connector element.
| RemoveTransformExpression | Removes a transform expression previously defined for the current instance.
| RemoveWarning | Removes the specified data warning from the current instance.
| ResumeOutputAutoUpdate | Resumes the automatic update for the output elements.
| ResumeOutputAutoUpdate(Boolean) | Resumes the automatic update for the output elements.
| SuppressOutputAutoUpdate | Suppresses the automatic update for the output elements.
| TakeSnapshot | Returns a snapshot that can be used to detect future changes to this transform.
| ValidateSettingValues | Validates the settings values against their type, valid values and allowed range.
| ValidateTransform | Validates the transform prior to execution and throws if any setting values are invalid.

Top
See Also

#### Reference

Dundas.BI.Data.Transforms Namespace