This document is provided on an "AS IS" basis without warranties of any kind. Smartsite iXperion class libraries may change in future releases.

Syntax

C#	Copy Code
public sealed class DataTableViperModule

Visual Basic (Declaration)	Copy Code
Public NotInheritable Class DataTableViperModule

The type exposes the following methods.

Public Methods

	Name	Description
	AddAIMRelation	Adds an item to the AIM relations collection. (Inherited from Module.)
	Aggregate	Overloaded.
	Append	Appends data from the given datatables to the source table, using the specified options.
	ApplyProperties	Applies the properties from the SXML processing environment into the current module. (Inherited from BaseModule.)
	BeginExecute	Override this to execute code before Execute() is fired. Last point to add data to the Cache Signature. (Inherited from Module.)
	Capture	Passes an SXML subtree to the current module. (Inherited from BaseModule.)
	CheckTimeout	Checks whether execution has timed out, given the setting of TimeoutMilliseconds()()()(). (Inherited from BaseModule.)
	ClearForcedResult	Sets the result of the macro. used to override the normal handling of the result creation. (Inherited from Module.)
	Clone	Return a clone of the given datatable.
	ColumnRemove	Removes an existing column from the datatable.
	ColumnsAdd	Overloaded.
	ColumnsCount	Returns the number of columns in the datatable.
	ColumnsExists	Returns true if the column name exists, false otherwise.
	ColumnsGetName	Gets the column name by its index.
	ColumnsGetNames	Returns a datatable containing all the column names in this datatable.
	ColumnsGetOrdinal	Returns the ordinal of the given column name.
	ColumnsGetType	Overloaded.
	ColumnsRename	Overloaded.
	Compute	Overloaded.
	Create	Creates a new datatable containing a single row where the column names and the values are determined by the parameters.
	CreateEmpty	Overloaded.
	CreateForInputData	Creates an empty datatable for use as input for the given macro parameter
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from BaseModule.)
	Distinct	Returns a datatable with a single column, containing all the distinct values in the column.
	DoPreparse	Check whether to preparse data in the given property. (Inherited from BaseModule.)
	DoRecurseTag	Determines whether to recurse on a given tag
	EndExecute	Override this to execute code after Execute() is fired. (Inherited from Module.)
	Equals	(Inherited from Object.)
	EvaluatePropertyExpression	Evaluates an expression in a property with Expression Syntax (Inherited from Module.)
	Execute	Execute the macro. Should be overridden by inherited class. (Inherited from Module.)
	ExecuteRawParameter	Executes the data of a raw parameter. (Inherited from Module.)
	ExistsBuffer	Checks whether a local buffer exists. (Inherited from BaseModule.)
	Find	Finds the specified child module. (Inherited from BaseModule.)
	FindExtension	Finds an extension macro. (Inherited from BaseModule.)
	FindOne	Finds a single row and returns the row number (-1 if not found).
	GetAIMRelations	Gets a list of all outgoing AIM relations created by the macro. (Inherited from BaseModule.)
	GetBuffer	Gets a local buffer. (Inherited from BaseModule.)
	GetBytes	Overloaded.
	GetException	Returns the text message of the exception that has occurred. (Inherited from BaseModule.)
	GetExceptionSmartsiteCode	Returns the Smartsite Error code of the exception that has occurred. (Inherited from BaseModule.)
	GetExceptionString	Returns the full information of the exception that has occurred, including the stack trace. (Inherited from BaseModule.)
	GetExceptionType	Returns the full Type name of the exception that has occurred. (Inherited from BaseModule.)
	GetForcedResult	Gets the forced result of the macro, set by overriding the normal rendering using SetForcedResult(). (Inherited from Module.)
	GetHashCode	(Inherited from Object.)
	GetInnerException	Returns the text message of the inner exception of the exception that has occurred. (Inherited from BaseModule.)
	GetInnerExceptionSmartsiteCode	Returns Smartsite error code of the inner exception of the exception that has occurred. (Inherited from BaseModule.)
	GetInnerExceptionString	Returns the full information of the inner exception of the exception that has occurred, including the stack trace. (Inherited from BaseModule.)
	GetInnerExceptionType	Returns the full Type name of the inner exception of the exception that has occurred. (Inherited from BaseModule.)
	GetParameter	Gets the value of the given parameter/property. (Inherited from BaseModule.)
	GetParameter	Gets the value of the given parameter/property. (Inherited from BaseModule.)
	GetParent	Gets the parent Module of this module. (Inherited from BaseModule.)
	GetParent	Gets the parent Module of this module, optionally crossing RenderContext boundaries if allowed so by embeds (Sandboxing off). (Inherited from BaseModule.)
	GetRenderTime	Returns the render time of the macro in milliseconds. (Inherited from Module.)
	GetResult	Returns the result of the macro. Typically used in the ResultFormat property, to format, convert or encode the result. (Inherited from BaseModule.)
	GetResult	Returns the result of the macro. Typically used in the ResultFormat property, to format, convert or encode the result. (Inherited from BaseModule.)
	GetType	(Inherited from Object.)
	GetValue	Overloaded.
	Initialize	Called to initialize this Module (Inherited from BaseModule.)
	IsChildOf	Determines whether the module is a descendant of the given parent (Inherited from BaseModule.)
	IsValid	Determines whether the specified data table is valid (i.e. not closed and has at least one field).
	Join	Joins the datatables into one.
	ParameterExists	Checks whether the given parameter/property is set. (Inherited from BaseModule.)
	PreInitialize	Called just before initialization of the module (Inherited from Module.)
	ReadyExecuting	Method that is called after the module has executed. (Inherited from Module.)
	RowsAdd	Adds a new row to the datatable with the given values.
	RowsCount	Gets the number of rows in the datatable.
	RowsInsertAt	Inserts a new row at given row index in the datatable.
	RowsRemove	Removes the rows based on the given expression.
	RowsRemoveAll	Removes all the rows in the datatable.
	RowsRemoveAt	Removes the given row numbers from the datatable.
	RowsRemoveDuplicates	Overloaded.
	RowsRemoveRange	Overloaded.
	ScopeTerminated	Executed when the module is about to get out of scope. (Inherited from BaseModule.)
	Search	Searches the specified data table using the given expression.
	SetBuffer	Sets a local buffer. (Inherited from BaseModule.)
	SetForcedResult	Sets the result of the macro. used to override the normal handling of the result creation. (Inherited from Module.)
	SetForcedResult	Sets the result of the macro. used to override the normal handling of the result creation. (Inherited from Module.)
	SetForcedResult	Sets the result of the macro. used to override the normal handling of the result creation. (Inherited from Module.)
	SetForcedResult	Sets the result of the macro. used to override the normal handling of the result creation. (Inherited from Module.)
	SetForcedResult	Sets the result of the macro. used to override the normal handling of the result creation. (Inherited from Module.)
	SetForcedResult	Sets the result of the macro. used to override the normal handling of the result creation. (Inherited from Module.)
	SetForcedResult	Sets the result of the macro. used to override the normal handling of the result creation. (Inherited from Module.)
	SetValue	Overloaded.
	SimpleFormat	Overloaded.
	SimpleFormatRow	Formats a single row in the given datatable and returns a string using the given formatting parameters.
	Sort	Sorts the specified datatable.
	TestCondition	Tests whether execution should take place based on the expression in the condition property (Inherited from Module.)
	TestPropertyExpression	Tests whether an expression in a property with Expression Syntax evaluates to true. (Inherited from Module.)
	ThrowCurrentException	Makes Smartsite throw the current exception. (Inherited from BaseModule.)
	ThrowInnerException	Makes Smartsite throw the inner exception. (Inherited from BaseModule.)
	ToString	Returns a string that represents the current macro. (Inherited from Module.)
	ToString	Returns a String that represents the current Object. (Inherited from Module.)
	ToXml	Gets an XML representation of the DataTable.
	Transpose	Return the transposed version of the given datatable.

Protected Methods

	Name	Description
	Finalize	(Inherited from Object.)
	IsBufferName	Determines whether the data is a buffer name. (Inherited from Module.)
	IsSingleSaveBuffername	Determines whether a single save buffername is used. (Inherited from Module.)
	MemberwiseClone	(Inherited from Object.)
	SetCurrentProperty	Sets the current property. (Inherited from BaseModule.)

Explicit Interface Implementations

	Name	Description
	IModuleExec..::..Cancel	(Inherited from BaseModule.)
	IModuleExec..::..FinishExecute	(Inherited from BaseModule.)
	IModuleExec..::..Initialize	(Inherited from BaseModule.)
	IModuleExec..::..SetChildException	(Inherited from BaseModule.)
	IModuleExec..::..SetInitialized	Triggers the Initialized status in the module. (Inherited from BaseModule.)
	IModuleExec..::..SetProperty	(Inherited from BaseModule.)
	IModuleExec..::..SetProperty	(Inherited from BaseModule.)
	IModuleExec..::..StartExecute	(Inherited from BaseModule.)

Syntax

Public Methods

Protected Methods

Explicit Interface Implementations

See Also