Class Properties

Namespace

Dynamicweb.Modules

Assembly

Dynamicweb.dll

This class contains the methods and properties for work with properties hashtable related to module settings on a paragraph.

public sealed class Properties

Inheritance

object

Properties

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

Remarks

See Dynamicweb.ContentModule where this object is in use.

Constructors

Properties()

Initialize a new node hashtable.

public Properties()

Properties

this[string]

Stores and retrieves Item of the current name value.

public string this[string name] { get; set; }

Parameters

name string

Property Value

string

String

ModuleBeingAttached

Used on Module Settings tab on paragraphs to see if the module is being attached

public bool ModuleBeingAttached { get; }

Property Value

bool

Values

Returns the nodes hashtable.

public IDictionary<string, string> Values { get; }

Property Value

IDictionary<string, string>

Hashtable

Methods

GetParagraphModuleSettings(int, bool)

Returns the paragraph module settings for the specified ParagraphID, should be used only from backend.

public static Properties GetParagraphModuleSettings(int paragraphId, bool checkForWorkflow)

Parameters

paragraphId int

checkForWorkflow bool

Returns

Properties

GetParagraphModuleSettings(int, string)

Returns the paragraph module settings for the specified module on the specified page.

public static Properties GetParagraphModuleSettings(int pageId, string paragraphModuleSystemName)

Parameters

pageId int

paragraphModuleSystemName string

Returns

Properties

GetTableByNode(string)

Get current node from hashtable.

public string GetTableByNode(string node)

Parameters

node string

Returns

string

String

GetValue(string)

Retrieves values from the nodes collection.

public string GetValue(string name)

Parameters

name string

Returns

string

LoadProperties()

Loads the properties for the module tab of the current Paragraph. Used on Paragraph Module Settings tab.

public static Properties LoadProperties()

Returns

Properties

Properties.

LoadProperties(DataRow)

Loads the properties of the current ParagraphRow.

public static Properties LoadProperties(DataRow paragraphRow)

Parameters

paragraphRow DataRow

Current ParagraphRow.

Returns

Properties

Properties.

LoadProperties(int)

Loads the properties of the specified paragraph

public static Properties LoadProperties(int paragraphId)

Parameters

paragraphId int

The ID of the paragraph

Returns

Properties

Properties.

LoadProperty(string)

Load property from the source to the hashtable.

public void LoadProperty(string xml)

Parameters

xml string

LoadProperty(string, bool)

Load property from the source to the hashtable.

public void LoadProperty(string xml, bool merge)

Parameters

xml string

merge bool

SetDefaultValue(string, string)

Use to set default values used if no value is present or there is no underlying data

public void SetDefaultValue(string name, string newValue)

Parameters

name string

Name of the property

newValue string

Value of the property

SetValue(string, string)

Stores values from the nodes collection.

public void SetValue(string name, string value)

Parameters

name string

value string

ToString()

Returns a serialized XML-string representing the current object.

public override string ToString()

Returns

string

A string representation of the current object.