Class InstallFile

The InstallFile class represents a single file in an Installer Package.

Inheritance

System.Object

InstallFile

Namespace: DotNetNuke.Services.Installer

Assembly: DotNetNuke.dll

Syntax

public class InstallFile : object

Constructors

| Improve this Doc View Source

InstallFile(String, InstallerInfo)

Initializes a new instance of the InstallFile class. This Constructor creates a new InstallFile instance.

Declaration

public InstallFile(string fileName, InstallerInfo info)

Parameters

Type	Name	Description
System.String	fileName	The fileName of the File.
InstallerInfo	info	An INstallerInfo instance.

| Improve this Doc View Source

InstallFile(String, String, InstallerInfo)

Initializes a new instance of the InstallFile class. This Constructor creates a new InstallFile instance.

Declaration

public InstallFile(string fileName, string sourceFileName, InstallerInfo info)

Parameters

Type	Name	Description
System.String	fileName	The fileName of the File.
System.String	sourceFileName	Source file name.
InstallerInfo	info	An INstallerInfo instance.

| Improve this Doc View Source

InstallFile(String, String)

Initializes a new instance of the InstallFile class. This Constructor creates a new InstallFile instance.

Declaration

public InstallFile(string fileName, string filePath)

Parameters

Type	Name	Description
System.String	fileName	The file name of the File.
System.String	filePath	The file path of the file.

| Improve this Doc View Source

InstallFile(String)

Initializes a new instance of the InstallFile class. This Constructor creates a new InstallFile instance.

Declaration

public InstallFile(string fileName)

Parameters

Type	Name	Description
System.String	fileName	The fileName of the File.

| Improve this Doc View Source

InstallFile(ZipArchiveEntry, InstallerInfo)

Initializes a new instance of the InstallFile class. This Constructor creates a new InstallFile instance from a ZipInputStream and a ZipEntry.

Declaration

public InstallFile(ZipArchiveEntry entry, InstallerInfo info)

Parameters

Type	Name	Description
ZipArchiveEntry	entry	The ZipEntry.
InstallerInfo	info	An INstallerInfo instance.

Remarks

The ZipInputStream is read into a byte array (Buffer), and the ZipEntry is used to set up the properties of the InstallFile class.

| Improve this Doc View Source

InstallFile(ZipInputStream, ZipEntry, InstallerInfo)

The InstallFile class represents a single file in an Installer Package.

Declaration

public InstallFile(ZipInputStream zip, ZipEntry entry, InstallerInfo info)

Parameters

Type	Name	Description
ZipInputStream	zip
ZipEntry	entry
InstallerInfo	info

Properties

| Improve this Doc View Source

Action

Gets or sets the Action for this file.

Declaration

public string Action { get; set; }

Property Value

Type	Description
System.String	A string.

| Improve this Doc View Source

BackupFileName

Gets the location of the backup file.

Declaration

public string BackupFileName { get; }

Property Value

Type	Description
System.String	A string.

| Improve this Doc View Source

BackupPath

Gets the location of the backup folder.

Declaration

public virtual string BackupPath { get; }

Property Value

Type	Description
System.String	A string.

| Improve this Doc View Source

Encoding

The InstallFile class represents a single file in an Installer Package.

Declaration

public TextEncoding Encoding { get; }

Property Value

Type	Description
TextEncoding

| Improve this Doc View Source

Extension

Gets the File Extension of the file.

Declaration

public string Extension { get; }

Property Value

Type	Description
System.String	A string.

| Improve this Doc View Source

FullName

Gets the Full Name of the file.

Declaration

public string FullName { get; }

Property Value

Type	Description
System.String	A string.

| Improve this Doc View Source

InstallerInfo

Gets the associated InstallerInfo.

Declaration

public InstallerInfo InstallerInfo { get; }

Property Value

Type	Description
InstallerInfo	An InstallerInfo object.

| Improve this Doc View Source

Name

Gets the Name of the file.

Declaration

public string Name { get; }

Property Value

Type	Description
System.String	A string.

| Improve this Doc View Source

Path

Gets the Path of the file.

Declaration

public string Path { get; }

Property Value

Type	Description
System.String	A string.

| Improve this Doc View Source

SourceFileName

Gets the source file name.

Declaration

public string SourceFileName { get; }

Property Value

Type	Description
System.String	A string.

| Improve this Doc View Source

TempFileName

Gets the location of the temporary file.

Declaration

public string TempFileName { get; }

Property Value

Type	Description
System.String	A string.

| Improve this Doc View Source

Type

Gets or sets the Type of the file.

Declaration

public InstallFileType Type { get; set; }

Property Value

Type	Description
InstallFileType	An InstallFileType Enumeration.

| Improve this Doc View Source

Version

Gets the Version of the file.

Declaration

public Version Version { get; }

Property Value

Type	Description
Version	A System.Version.

Methods

| Improve this Doc View Source

SetVersion(Version)

The SetVersion method sets the version of the file.

Declaration

public void SetVersion(Version version)

Parameters

Type	Name	Description
Version	version	The version of the file.

Extension Methods

JsonExtensionsWeb.ToJson(Object)