Class File

Namespace

Kentico.Xperience.AmazonStorage

Assembly

Kentico.Xperience.AmazonStorage.dll

Implementation of File class for Amazon S3.

public class File : AbstractFile

Inheritance

object

AbstractFile

File

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

File()

Initializes a new instance of the File class, which provides operations with files.

public File()

Properties

Provider

Get or set S3ObjectInfoProvider.

public static IS3ObjectInfoProvider Provider { get; set; }

Property Value

IS3ObjectInfoProvider

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 override 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 override 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. Overwriting a file of the same name is not allowed.

public override 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 override 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 override 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 override 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 override void Delete(string path)

Parameters

path string

Path to file

Exists(string)

Determines whether the specified file exists.

public override bool Exists(string path)

Parameters

path string

Path to file.

Returns

bool

ExistsInFileSystem(string)

Returns whether given file exist in file system.

protected virtual bool ExistsInFileSystem(string path)

Parameters

path string

Path to given file.

Returns

bool

GetFileStream(string, FileMode)

Returns new instance of FileStream class.

protected virtual FileStream GetFileStream(string path, FileMode mode)

Parameters

path string

Path.

mode FileMode

File mode.

Returns

FileStream

GetFileStream(string, FileMode, FileAccess)

Returns new instance of FileStream class.

protected virtual FileStream GetFileStream(string path, FileMode mode, FileAccess access)

Parameters

path string

Path.

mode FileMode

File mode.

access FileAccess

File access.

Returns

FileStream

GetFileUrl(string)

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

public override string GetFileUrl(string path)

Parameters

path string

Virtual path starting with ~ or absolute path.

Returns

string

GetHashString(string)

Returns Hashed string from specified query string. Hashed string is not user specific.

protected virtual string GetHashString(string query)

Parameters

query string

Query to hash.

Returns

string

GetLastWriteTime(string)

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

public override 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 override 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 override 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 override 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 override 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 override 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 override 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 override 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 override 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 override 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 override 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 override 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 override 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