Class AbstractFile

Namespace

CMS.IO

Assembly

CMS.IO.dll

Abstract class for file providers.

public abstract class AbstractFile

Inheritance

object

AbstractFile

Derived

File

ZipFile

File

File

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Methods

AppendAllText(string, string)

Opens a file, appends the specified string to the file, and then closes the file. If the file does not exist, this method creates a file, writes the specified string to the file, then closes the file.

public abstract void AppendAllText(string path, string contents)

Parameters

path string

Path

contents string

Content to write

AppendAllText(string, string, Encoding)

Opens a file, appends the specified string to the file, and then closes the file. If the file does not exist, this method creates a file, writes the specified string to the file, then closes the file.

public abstract void AppendAllText(string path, string contents, Encoding encoding)

Parameters

path string

Path

contents string

Content to write

encoding Encoding

The character encoding to use

Copy(string, string)

Copies an existing file to a new file.

public abstract void Copy(string sourceFileName, string destFileName)

Parameters

sourceFileName string

Path to source file

destFileName string

Path to destination file

Copy(string, string, bool)

Copies an existing file to a new file. Overwriting a file of the same name is allowed.

public abstract void Copy(string sourceFileName, string destFileName, bool overwrite)

Parameters

sourceFileName string

Path to source file

destFileName string

Path to destination file

overwrite bool

If destination file should be overwritten

Create(string)

Creates or overwrites a file in the specified path.

public abstract FileStream Create(string path)

Parameters

path string

Path to file

Returns

FileStream

CreateText(string)

Creates or opens a file for writing UTF-8 encoded text.

public abstract StreamWriter CreateText(string path)

Parameters

path string

Path to file

Returns

StreamWriter

Delete(string)

Deletes the specified file. An exception is not thrown if the specified file does not exist.

public abstract void Delete(string path)

Parameters

path string

Path to file

Exists(string)

Determines whether the specified file exists.

public abstract bool Exists(string path)

Parameters

path string

Path to file

Returns

bool

GetFileUrl(string)

Returns URL to file. If can be accessed directly then direct URL is generated else URL with GetFile page is generated.

public abstract string GetFileUrl(string path)

Parameters

path string

Virtual path starting with ~ or absolute path.

Returns

string

GetLastWriteTime(string)

Returns the date and time the specified file or directory was last written to.

public abstract DateTime GetLastWriteTime(string path)

Parameters

path string

Path to file

Returns

DateTime

Move(string, string)

Moves a specified file to a new location, providing the option to specify a new file name.

public abstract void Move(string sourceFileName, string destFileName)

Parameters

sourceFileName string

Source file name

destFileName string

Destination file name

Open(string, FileMode, FileAccess)

Opens a FileStream on the specified path, with the specified mode and access.

public abstract FileStream Open(string path, FileMode mode, FileAccess access)

Parameters

path string

Path to file

mode FileMode

File mode

access FileAccess

File access

Returns

FileStream

OpenRead(string)

Opens an existing file for reading.

public abstract FileStream OpenRead(string path)

Parameters

path string

Path to file

Returns

FileStream

OpenText(string)

Opens an existing UTF-8 encoded text file for reading.

public abstract StreamReader OpenText(string path)

Parameters

path string

Path to file

Returns

StreamReader

ReadAllBytes(string)

Opens a binary file, reads the contents of the file into a byte array, and then closes the file.

public abstract byte[] ReadAllBytes(string path)

Parameters

path string

Path to file

Returns

byte[]

ReadAllText(string)

Opens a text file, reads all lines of the file, and then closes the file.

public abstract string ReadAllText(string path)

Parameters

path string

Path to file

Returns

string

ReadAllText(string, Encoding)

Opens a text file, reads all lines of the file, and then closes the file.

public abstract string ReadAllText(string path, Encoding encoding)

Parameters

path string

Path to file

encoding Encoding

The character encoding to use

Returns

string

SetAttributes(string, FileAttributes)

Sets the specified FileAttributes of the file on the specified path.

public abstract void SetAttributes(string path, FileAttributes fileAttributes)

Parameters

path string

Path to file

fileAttributes FileAttributes

File attributes

SetLastWriteTime(string, DateTime)

Sets the date and time that the specified file was last written to.

public abstract void SetLastWriteTime(string path, DateTime lastWriteTime)

Parameters

path string

Path to file

lastWriteTime DateTime

Last write time

WriteAllBytes(string, byte[])

Creates a new file, writes the specified byte array to the file, and then closes the file. If the target file already exists, it is overwritten.

public abstract void WriteAllBytes(string path, byte[] bytes)

Parameters

path string

Path to file

bytes byte[]

Bytes to write

WriteAllText(string, string)

Creates a new file, write the contents to the file, and then closes the file. If the target file already exists, it is overwritten.

public abstract void WriteAllText(string path, string contents)

Parameters

path string

Path to file

contents string

Content to write

WriteAllText(string, string, Encoding)

Creates a new file, write the contents to the file, and then closes the file. If the target file already exists, it is overwritten.

public abstract void WriteAllText(string path, string contents, Encoding encoding)

Parameters

path string

Path to file

contents string

Content to write

encoding Encoding

The character encoding to use