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 Embed

Visual Basic (Declaration)	Copy Code
Public Class Embed

The type exposes the following properties.

Public Properties

	Name	Description
	AcceptsInnerXml	Returns true if the module currently accepts string data within the macro tags. (Inherited from BaseModule.)
	AccessDeniedReturnValue	Gets or sets the value that is returned when the site visitor has insufficient access. (Inherited from Module.)
	AIMMode	Gets or sets the AIM scanning mode of the macro. (Inherited from Module.)
	AIMOrigin	Returns the current AIM source. If AIMMode is Autonomous, the current instructionsource is used, otherwise the current item. (Inherited from Module.)
	BufferNames	Gets or sets the buffer names. (Inherited from Module.)
	Condition	Gets or sets the Viper expression to evaluate before actually executing the macro. If the expression returns false, the execution of the module and its child modules is skipped. (Inherited from Module.)
	ConditionMatched	Must return true if TestCondition() matched. (Inherited from Module.)
	CurrentCacheModule	Returns a reference to the current cache module, if the current instruction is encapsulated by a cache block. (Inherited from Module.)
	CurrentProperty	Gets the property currently being set on the module. (Inherited from BaseModule.)
	CustomPostData	Gets or sets the custom post data.
	CustomRequestBody	Gets or sets the custom request body. (Inherited from EmbedBase.)
	CustomRequestContentType	Gets or sets the content type of the request when CustomRequestBody is set. (Inherited from EmbedBase.)
	DefaultValue	Gets or sets the default value that will be returned when the execution would otherwise return an empty string. (Inherited from Module.)
	DoAddBaseHref	Set to true to add a base href element to the head section of the embedded page. (Inherited from EmbedBase.)
	DoFixLinks	Fixes links to self and relative resources. (Inherited from EmbedBase.)
	FollowRedirect	Determines if redirect instructions from the embedded page are followed. (Inherited from EmbedBase.)
	Formatting	Gets the formatting options. (Inherited from Module.)
	HasParameterSection	Returns true if the macro currently uses an SXML parameters section (Inherited from BaseModule.)
	Id	Gets or sets the unique id of the module instance during the current processing. Modules with Id set will be kept alive during the complete rendering and can be accessed from other modules using the Find method. (Inherited from BaseModule.)
	IsCancelled	Gets a value indicating whether the execution of the macro is cancelled. (Inherited from BaseModule.)
	IsSelfClosing	Gets a value indicating whether this instance is self closing. (Inherited from BaseModule.)
	LocalId	Gets or sets the local id of the macro in the current buffer scope. (Inherited from Module.)
	Location	Gets or sets the Locator location to embed. (Inherited from EmbedBase.)
	MinimumAccessTypeLevel	Friendly name of the minimum access type level required by the site visitor to execute this macro. (Inherited from Module.)
	ModuleInfo	Gets the module info. (Inherited from BaseModule.)
	OnErrorReturnValue	Gets or sets the value to return in case on error occurs during execution. The Viper expressions this.error(), this.error(full) and this.error(type) are available in this context. (Inherited from Module.)
	OutputDecoding	Gets or sets a value indicating whether to use output decoding before sending the response to the client.
	PostDirect	Set to true to make form actions point to the embedded page directly, without passing through Smartsite. (Inherited from EmbedBase.)
	Properties	Gets the full list of properties as set when executing the module. (Inherited from BaseModule.)
	Remarks	Gets or sets the remarks. Remarks have no effect on the actual execution of the module. They only improve the readability of the code. (Inherited from BaseModule.)
	Result	Returns a reference to the module result (Inherited from BaseModule.)
	ResultFormat	Gets or sets the resultformat. (Inherited from Module.)
	ResultType	Gets or sets the type of the result. (Inherited from BaseModule.)
	State	Gets a key/value collection that can be used to organize and share data during the lifecycle of a module. (Inherited from BaseModule.)
	Status	Gets a value indicating the ModuleStatus of this module. (Inherited from BaseModule.)
	SXMLPath	Gets the path to the macro in the current execution stack. (Inherited from BaseModule.)
	TimeoutSeconds	Gets or sets the timeout in seconds. In the overriden Execute() method, you can call CheckTimeout() to check whether execution has timed out. (Inherited from BaseModule.)
	Trim	Gets a value indicating how the whitespace is trimmed. (Inherited from BaseModule.)
	TypeName	Gets the name of the Module type. (Inherited from BaseModule.)
	UsePostData	Pass posted form data to the embedded page. (Inherited from EmbedBase.)
	UserSetPropertyList	Gets the user-set property list. (Inherited from BaseModule.)
	UseSandbox	Gets or sets a value indicating whether to run the embed in a sandbox. (Inherited from EmbedBase.)
	Whitespace	Gets a value indicating whether to preserve whitespace. (Inherited from BaseModule.)

Protected Properties

	Name	Description
	AIMPassThrough	Gets or sets a value indicating whether to use AIM pass through. (Inherited from EmbedBase.)
	IContext	Gets a reference to the IContext interface. (Inherited from BaseModule.)
	Password	Gets or sets the password. (Inherited from EmbedBase.)
	Settings	Gets the Rendering _settings. (Inherited from EmbedBase.)
	UserName	Gets or sets the user name. (Inherited from EmbedBase.)

Explicit Interface Implementations

	Name	Description
	IAIMModule..::..AIMRelations	(Inherited from BaseModule.)
	IModuleExec..::..Context
	IModuleExec..::..InstructionSource	(Inherited from BaseModule.)
	ISXMLInstruction..::..Name	(Inherited from BaseModule.)
	IModuleExec..::..ProcessingContext

Syntax

Public Properties

Protected Properties

Explicit Interface Implementations

See Also