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 Webservice

Visual Basic (Declaration)	Copy Code
Public Class Webservice

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.)
	BindingConfigurationName	Gets or sets the name of the binding configuration. When you specify a BindingConfigurationName, the web.config must contain a binding configuration section with that name.
	BindingType	Gets or sets the type of the binding.
	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.)
	DefaultValue	Gets or sets the default value that will be returned when the execution would otherwise return an empty string. (Inherited from Module.)
	EndpointConfigurationName	Gets or sets the name of the endpoint configuration. When you specify an EndpointConfigurationName, the web.config must contain an (client) endpoint configuration with that name.
	Format	Gets or sets the formatting Xml. (Inherited from ResultSetModule.)
	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.)
	LiteralMethodNode	Literal body element, which will be appended to the method-node of the SoapEnvelope. Use either this property or the MethodArguments property to specify the method arguments/parameters. (When both properties are specified, LiteralMethodeNode will be ignored.)
	LocalId	Gets or sets the local id of the macro in the current buffer scope. (Inherited from Module.)
	MaxReceivedMessageSize	Gets or sets the max received message size. If BindingConfigurationName has been specified as well, MaxReceivedMessageSize will be ignored.
	MaxRows	Gets or sets a limit for the number of rows that the output may contain. (Inherited from ResultSetModule.)
	MethodArguments	The method arguments.
	MethodName	The name of the webservice method that should be invoked. It is required to either specify the MethodName or the LiteralMethodNode parameter.
	MethodNamespace	The namespace to be used on the MethodName.
	MethodNamespacePrefix	The prefix to be used for the MethodNamespace.
	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.)
	OutputInnerText	If true, the "innerText" of the SoapEnvelope response will be returned as result. If false, the result should be formatted using the format-parameter.
	OutputRequestEnvelope	Outputs the request SoapEnvelope as string (debug option). The actual request will not be executed, so there will be no response.
	ParametersNamespace	The namespace to be used for the parameters/arguments inside the body element.
	Password	Gets or sets the password. Only needed when the webservice is restricted by means of basic http authentication.
	Properties	Gets the full list of properties as set when executing the module. (Inherited from BaseModule.)
	RawSoapHeaders	Gets or sets the raw (literal) SOAP headers.
	ReadSchema	Gets or sets a value indicating whether to use the option XmlReadMode.ReadSchema when reading the response into a DataSet. This setting is only applicable when resulttype has been set to DataTable.
	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.)
	RowDelimiter	Specifies the delimiter string that separates individual records. (Inherited from ResultSetModule.)
	RowFormat	Gets or sets the formatting string. (Inherited from ResultSetModule.)
	SendTimeout	Gets or sets the send timeout (in seconds). When you need to set one of the other timeout values, use a binding configuration section and specify its name using the parameter BindingConfigurationName.
	SkipRows	Specifies which row will be the first row in the output. (Inherited from ResultSetModule.)
	SoapAction	The SoapAction HTTP header. When not specified, it defaults to MethodNamespace + MethodName.
	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.)
	Url	The url of the webservice.
	UserName	Gets or sets the name of the user. Only needed when the webservice is restricted by means of basic http authentication.
	UserSetPropertyList	Gets the user-set property list. (Inherited from BaseModule.)
	Whitespace	Gets a value indicating whether to preserve whitespace. (Inherited from BaseModule.)
	WriteTypeAttributes	Determines if type-information (e.g. xsi:type= 'xsd:int') should be included on the argument(s). Defaults to true.

Protected Properties

	Name	Description
	CurrentlyFormatting	Returns true if currently formatting (Inherited from ResultSetModule.)
	IContext	Gets a reference to the IContext interface. (Inherited from BaseModule.)

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