Click or drag to resize
AlchemyPluginSettings Class
Represents the settings element of an a4t.xml document with helpers for retrieving the various settings.
Inheritance Hierarchy
SystemObject
  Alchemy4Tridion.Plugins.InfoPluginSettings

Namespace: Alchemy4Tridion.Plugins.Info
Assembly: Alchemy4Tridion.Plugins (in Alchemy4Tridion.Plugins.dll) Version: 1.0.0.0 (0.7.0.0)
Syntax
C#
public class PluginSettings : IPluginSettings

The PluginSettings type exposes the following members.

Constructors
  NameDescription
Public methodPluginSettings(IAlchemyPlugin)
Constructor for extracting the settings from a a4t.xml file within a plugin's plugin path.
Public methodPluginSettings(String, IAlchemyPlugin)
Constructor for extracting th esettings from a given a4t.xml document.
Public methodPluginSettings(XDocument, IAlchemyPlugin)
Constructor for extracting the settings from a given a4t.xml document.
Top
Methods
  NameDescription
Public methodDecrypt
If the given encryption key matches the ISettingsEncryptorService's key of the plugin, will decypt values that are retrieved via the Get methods.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGet(String, String)
Gets a value from the plugin settings.
Public methodGet(Type, Boolean)
Gets all of the client only settings at this level deserialized into a strongly typed object.
Public methodGetT
Gets all of the settings at this level deserialized into a strongly typed object.
Public methodGetT(Boolean)
Gets all of the client only settings at this level deserialized into a strongly typed object.
Public methodGetT(String)
Gets a value from the plugin settings as a specific type.
Public methodGetT(String, T)
Gets a value from the plugin settings as a specific type.
Public methodGetAsClientType
Gets a deserialized object based off of client only settings at the root level of the settings element.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetList
Gets a setting's value as a list of string values.
Public methodGetNestedSettings
Gets a value as a nested PluginSettings instance (for non 'add' elements, the key will be the element's name and the value will be the element's value.
Public methodGetSetting
Gets a plugin setting value as an underyling PluginSetting instance.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodSave
Saves the a4t.xml file with any changes that have been made.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Properties
  NameDescription
Public propertyDecryptValues
Gets whether or not the values will be decrypted by the Get methods.
Public propertyEncryptionKey
Gets the encryption key that was used with the Decrypt method.
Public propertyKeys
Gets the keys of the root level that this instance represents.
Public propertyPlugin
Reference to the plugin that these settings belong to. Can be null if the settings were not created by the plugin itself.
Top
Remarks
See unit tests for more examples of basic and advanced usage.
Examples
string setting = settings.Get("SomeKey");
See Also