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 class ItemDataModule

Visual Basic (Declaration)	Copy Code
Public Class ItemDataModule

The type exposes the following methods.

Public Methods

	Name	Description
	ActivationDate	Returns the item's last activation date.
	AddAIMRelation	Adds an item to the AIM relations collection. (Inherited from Module.)
	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.)
	Code	Returns the item's code.
	ContentTypeCode	Overloaded.
	ContentTypeName	Overloaded.
	ContentTypeNumber	Overloaded.
	Dispose	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. (Inherited from BaseModule.)
	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. (Overrides Module..::Execute()()()().)
	ExecuteRawParameter	Executes the data of a raw parameter. (Inherited from Module.)
	ExistsBuffer	Checks whether a local buffer exists. (Inherited from BaseModule.)
	ExistsField	Checks whether the given field exists. (Inherited from ResultSetModule.)
	FieldExists	Returns true if the given property exists on the current item.
	FieldValue	Overloaded.
	Find	Finds the specified child module. (Inherited from BaseModule.)
	FindExtension	Finds an extension macro. (Inherited from BaseModule.)
	GetAIMRelations	Gets a list of all outgoing AIM relations created by the macro. (Inherited from BaseModule.)
	GetBuffer	Gets a local buffer. (Inherited from BaseModule.)
	GetChildLevelResult	Gets the result of the child levels. (Inherited from ResultSetModule.)
	GetColumnCount	Gets the number of columns in the datatable. (Inherited from ResultSetModule.)
	GetColumnName	Gets the name of the current column. (Inherited from ResultSetModule.)
	GetColumnName	Gets the name of the given column. (Inherited from ResultSetModule.)
	GetColumnNumber	Gets the number of the current column. (Inherited from ResultSetModule.)
	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.)
	GetFieldValue	Gets the field value of the current column in the current row, when using colformat. (Inherited from ResultSetModule.)
	GetFieldValue	Gets the field value of the field with the given index in the current row. (Inherited from ResultSetModule.)
	GetFieldValue	Gets the field value of the field with the given name in the current row. (Inherited from ResultSetModule.)
	GetFieldValue	Gets the field value of the field with the given index in the current row. (Inherited from ResultSetModule.)
	GetFieldValue	Gets the field value of the field with the given name in the current row. (Inherited from ResultSetModule.)
	GetForcedResult	Gets the forced result of the macro, set by overriding the normal rendering using SetForcedResult(). (Inherited from Module.)
	GetGroup	Gets the name of the current group. (Inherited from ResultSetModule.)
	GetGroupCount	Gets the total number of groups displayed. (Inherited from ResultSetModule.)
	GetGroupNumber	Gets the number of the current group. (Inherited from ResultSetModule.)
	GetGroupResult	Gets the result of the current group. (Inherited from ResultSetModule.)
	GetGroupRowNumber	Gets the number of the current row in the current group. (Inherited from ResultSetModule.)
	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.)
	GetLevel	Gets the current formatting level. (Inherited from ResultSetModule.)
	GetLevelResult	Gets the result of the current level. (Inherited from ResultSetModule.)
	GetLevelRowNumber	Gets the current row of the current level. (Inherited from ResultSetModule.)
	GetLocation	Gets the location the current row points to, in a macro that can build URLs. (Inherited from ResultSetModule.)
	GetParam	Gets the value of a parameter with the given index. Useful when using the viper:exec inside xslt formatting. (Inherited from ResultSetModule.)
	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.)
	GetRawFieldValue	Gets the raw field value of the current column in the current row, when using colformat. (Inherited from ResultSetModule.)
	GetRawFieldValue	Gets the raw field value of the field with the given index in the current row. (Inherited from ResultSetModule.)
	GetRawFieldValue	Gets the raw field value of the field with the given name in the current row. (Inherited from ResultSetModule.)
	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.)
	GetRowCount	Gets the total number of rows in the datatable. (Inherited from ResultSetModule.)
	GetRowName	Gets the title or name represented by the current row. (Inherited from ResultSetModule.)
	GetRowNumber	Gets the current row number. (Inherited from ResultSetModule.)
	GetRowNumber	Gets the row number of the Nth parent level. Only available when using levelformat. (Inherited from ResultSetModule.)
	GetRowResult	Gets the result of the current row. (Inherited from ResultSetModule.)
	GetRowTitle	Gets the title represented by the current row. (Inherited from ResultSetModule.)
	GetType	(Inherited from Object.)
	GetVisibleRowCount	Gets the total number of rows displayed. (Inherited from ResultSetModule.)
	GetVisibleRowNumber	Gets the current visible row number. (Inherited from ResultSetModule.)
	Initialize	Called to initialize this Module (Inherited from BaseModule.)
	IsChildOf	Determines whether the module is a descendant of the given parent (Inherited from BaseModule.)
	IsFolder	Returns true if the item is a folder.
	IsHidden	Returns a boolean indicating whether the item is hidden from lists.
	LastModified	Returns the current item's Last Modified Date.
	MimeType	Returns the current item's Mime Type.
	Name	Overloaded.
	Number	Returns the number of the current item.
	ParameterExists	Checks whether the given parameter/property is set. (Inherited from BaseModule.)
	Parent	Returns the current item's parent number.
	PreInitialize	Called just before initialization of the module (Inherited from Module.)
	RawFieldValue	Overloaded.
	ReadyExecuting	Method that is called after the module has executed. (Inherited from Module.)
	ScopeTerminated	Executed when the module is about to get out of scope. (Inherited from BaseModule.)
	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.)
	Template	Returns the given field value of the Render Template of the current item.
	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	Overloaded.

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