Class ConfigurableAddIn

Namespace

Dynamicweb.Extensibility.AddIns

Assembly

Dynamicweb.Extensibility.dll

AddIn base class that enables parameters based configurable attributes

[AddInActive(true)]
[AddInUseParameterOrdering(false)]
[AddInUseParameterGrouping(false)]
[Serializable]
public class ConfigurableAddIn

Inheritance

object

ConfigurableAddIn

DatabaseContentProvider

TranslationProvider

Editor

DataItemProvider

HealthProviderBase

CheckoutHandler

ShippingProvider

FeedProvider

BaseLiveIntegrationAddIn

AddressValidatorProvider

DiscountExtenderBase

GatewayProvider

ReturnMerchandiseAuthorizationReplacementOrderProvider

SalesDiscountProvider

ConfigurableVatProvider

TaxProvider

StatisticsProvider

AddInWithEditors

CodeProviderBase

FieldTypeProvider

TextEditorAddIn

UrlDataProvider

IndexBuilderBase

MessageDeliveryProvider

RecipientContentProvider

BaseScheduledTaskAddIn

ExternalLoginProvider

BaseSmartSearchDataProvider

ReportProvider

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ConfigurableAddIn()

Initializes a new instance of the ConfigurableAddIn class.

public ConfigurableAddIn()

Methods

GetIdSuitableString(string)

Gets the id suitable string.

public string GetIdSuitableString(string inputValue)

Parameters

inputValue string

The input string.

Returns

string

System.String.

GetInstanceFromParameterXml<T>(string)

Gets the instance from parameter XML.

public static T GetInstanceFromParameterXml<T>(string xml) where T : ConfigurableAddIn

Parameters

xml string

The XML.

Returns

T

T.

Type Parameters

T

Exceptions

ArgumentException

xml or Parameter contains invalid XML.;xml

GetParametersToXml()

Gets the parameters to XML.

public virtual string GetParametersToXml()

Returns

string

System.String.

GetParametersToXml(bool)

Gets the parameters to XML.

public virtual string GetParametersToXml(bool includeDeclaration)

Parameters

includeDeclaration bool

if set to true [include declaration].

Returns

string

System.String.

LoadParametersFromXml(string)

Loads the parameters from XML.

public void LoadParametersFromXml(string xmlPar)

Parameters

xmlPar string

The XML par.

RenderAdditionalContent(TextWriter)

Renders the content of the additional.

public virtual void RenderAdditionalContent(TextWriter output)

Parameters

output TextWriter

The output.

SetValue(string, object)

Sets the value.

public void SetValue(string parameterName, object parameterValue)

Parameters

parameterName string

Name of the param.

parameterValue object

The param value.

UpdateFromPost(NameValueCollection)

Updates from post back. Get the parameter from Context.Current.Request.Form Form information. Null is allowed.

public void UpdateFromPost(NameValueCollection form)

Parameters

form NameValueCollection