Class ScriptInstaller

The ScriptInstaller installs Script Components to a DotNetNuke site.

Inheritance
System.Object
ComponentInstallerBase
FileInstaller
ScriptInstaller
Inherited Members
Namespace: DotNetNuke.Services.Installer.Installers
Assembly: DotNetNuke.dll
Syntax
public class ScriptInstaller : FileInstaller

Properties

| Improve this Doc View Source

AllowableFiles

Gets a list of allowable file extensions (in addition to the Host's List).

Declaration
public override string AllowableFiles { get; }
Property Value
Type Description
System.String
Overrides
| Improve this Doc View Source

CollectionNodeName

Gets the name of the Collection Node (scripts).

Declaration
protected override string CollectionNodeName { get; }
Property Value
Type Description
System.String
Overrides
| Improve this Doc View Source

InstallScript

Gets the base Install Script (if present).

Declaration
protected InstallFile InstallScript { get; }
Property Value
Type Description
InstallFile
| Improve this Doc View Source

InstallScripts

Gets the collection of versioned Install Scripts.

Declaration
protected SortedList<Version, InstallFile> InstallScripts { get; }
Property Value
Type Description
SortedList<Version, InstallFile>
| Improve this Doc View Source

ItemNodeName

Gets the name of the Item Node (script).

Declaration
protected override string ItemNodeName { get; }
Property Value
Type Description
System.String
Overrides
| Improve this Doc View Source

PostUpgradeScripts

Gets a list of Post-Upgrade Scripts (if present) - these scripts will always run after and versioned upgrade scripts and also after initial install.

Declaration
protected IList<InstallFile> PostUpgradeScripts { get; }
Property Value
Type Description
IList<InstallFile>

A list of InstallFile instances.
| Improve this Doc View Source

PreUpgradeScripts

Gets a list of Pre-Upgrade Scripts (if present) - these scripts will always run before any upgrade scripts but not upon initial installation.

Declaration
protected IList<InstallFile> PreUpgradeScripts { get; }
Property Value
Type Description
IList<InstallFile>

A list of InstallFile instances.
| Improve this Doc View Source

ProviderConfiguration

The ScriptInstaller installs Script Components to a DotNetNuke site.

Declaration
protected ProviderConfiguration ProviderConfiguration { get; }
Property Value
Type Description
ProviderConfiguration
| Improve this Doc View Source

UnInstallScripts

Gets the collection of UnInstall Scripts.

Declaration
protected SortedList<Version, InstallFile> UnInstallScripts { get; }
Property Value
Type Description
SortedList<Version, InstallFile>
| Improve this Doc View Source

UpgradeScript

The ScriptInstaller installs Script Components to a DotNetNuke site.

Declaration
protected InstallFile UpgradeScript { get; }
Property Value
Type Description
InstallFile

Methods

| Improve this Doc View Source

Commit()

The Commit method finalizes the Install and commits any pending changes.

Declaration
public override void Commit()
Overrides
Remarks

In the case of Files this is not necessary.

| Improve this Doc View Source

Install()

The Install method installs the file component.

Declaration
public override void Install()
Overrides
| Improve this Doc View Source

IsCorrectType(InstallFileType)

Gets a flag that determines what type of file this installer supports.

Declaration
protected override bool IsCorrectType(InstallFileType type)
Parameters
Type Name Description
InstallFileType type

The type of file being processed.
Returns
Type Description
System.Boolean

true if this is the correct type, otherwise false.
Overrides
| Improve this Doc View Source

ProcessFile(InstallFile, XPathNavigator)

The ProcessFile method determines what to do with parsed "file" node.

Declaration
protected override void ProcessFile(InstallFile file, XPathNavigator nav)
Parameters
Type Name Description
InstallFile file

The file represented by the node.
XPathNavigator nav

The XPathNavigator representing the node.
Overrides
| Improve this Doc View Source

Rollback()

The Rollback method undoes the installation of the file component in the event that one of the other components fails.

Declaration
public override void Rollback()
Overrides
| Improve this Doc View Source

UnInstall()

The UnInstall method uninstalls the file component.

Declaration
public override void UnInstall()
Overrides
| Improve this Doc View Source

UnInstallFile(InstallFile)

The UnInstallFile method unInstalls a single file.

Declaration
protected override void UnInstallFile(InstallFile scriptFile)
Parameters
Type Name Description
InstallFile scriptFile
Overrides

Extension Methods