PageModel.File Method

Reference

Definition

Namespace:: Microsoft.AspNetCore.Mvc.RazorPages

Assembly:: Microsoft.AspNetCore.Mvc.RazorPages.dll

Package:: Microsoft.AspNetCore.Mvc.RazorPages v2.0.0

Package:: Microsoft.AspNetCore.Mvc.RazorPages v2.1.0

Package:: Microsoft.AspNetCore.Mvc.RazorPages v2.2.0

Package:: Microsoft.AspNetCore.App.Ref v3.0.1

Package:: Microsoft.AspNetCore.App.Ref v3.1.10

Package:: Microsoft.AspNetCore.App.Ref v5.0.0

Package:: Microsoft.AspNetCore.App.Ref v6.0.6

Package:: Microsoft.AspNetCore.App.Ref v7.0.5

Package:: Microsoft.AspNetCore.App.Ref v8.0.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Overloads

File(String, String, String)	Returns the file specified by `virtualPath` (Status200OK) with the specified `contentType` as the Content-Type and the specified `fileDownloadName` as the suggested file name.
File(Stream, String, String)	Returns a file in the specified `fileStream` (Status200OK) with the specified `contentType` as the Content-Type and the specified `fileDownloadName` as the suggested file name.
File(Byte[], String, String)	Returns a file with the specified `fileContents` as content (Status200OK), the specified `contentType` as the Content-Type and the specified `fileDownloadName` as the suggested file name.
File(Stream, String)	Returns a file in the specified `fileStream` (Status200OK) with the specified `contentType` as the Content-Type.
File(Byte[], String)	Returns a file with the specified `fileContents` as content (Status200OK) and the specified `contentType` as the Content-Type.
File(String, String)	Returns the file specified by `virtualPath` (Status200OK) with the specified `contentType` as the Content-Type.

File(String, String, String)

Source:: PageModel.cs

Source:: PageModel.cs

Returns the file specified by virtualPath (Status200OK) with the specified contentType as the Content-Type and the specified fileDownloadName as the suggested file name.

public:
 virtual Microsoft::AspNetCore::Mvc::VirtualFileResult ^ File(System::String ^ virtualPath, System::String ^ contentType, System::String ^ fileDownloadName);

public virtual Microsoft.AspNetCore.Mvc.VirtualFileResult File (string virtualPath, string contentType, string fileDownloadName);

public virtual Microsoft.AspNetCore.Mvc.VirtualFileResult File (string virtualPath, string contentType, string? fileDownloadName);

abstract member File : string * string * string -> Microsoft.AspNetCore.Mvc.VirtualFileResult
override this.File : string * string * string -> Microsoft.AspNetCore.Mvc.VirtualFileResult

Public Overridable Function File (virtualPath As String, contentType As String, fileDownloadName As String) As VirtualFileResult

Parameters

virtualPath: String

The virtual path of the file to be returned.

contentType: String

The Content-Type of the file.

fileDownloadName: String

The suggested file name.

Returns

VirtualFileResult

The created VirtualFileResult for the response.

Applies to

File(Stream, String, String)

Source:: PageModel.cs

Source:: PageModel.cs

Returns a file in the specified fileStream (Status200OK) with the specified contentType as the Content-Type and the specified fileDownloadName as the suggested file name.

public:
 virtual Microsoft::AspNetCore::Mvc::FileStreamResult ^ File(System::IO::Stream ^ fileStream, System::String ^ contentType, System::String ^ fileDownloadName);

public virtual Microsoft.AspNetCore.Mvc.FileStreamResult File (System.IO.Stream fileStream, string contentType, string fileDownloadName);

public virtual Microsoft.AspNetCore.Mvc.FileStreamResult File (System.IO.Stream fileStream, string contentType, string? fileDownloadName);

abstract member File : System.IO.Stream * string * string -> Microsoft.AspNetCore.Mvc.FileStreamResult
override this.File : System.IO.Stream * string * string -> Microsoft.AspNetCore.Mvc.FileStreamResult

Public Overridable Function File (fileStream As Stream, contentType As String, fileDownloadName As String) As FileStreamResult

Parameters

fileStream: Stream

The Stream with the contents of the file.

contentType: String

The Content-Type of the file.

fileDownloadName: String

The suggested file name.

Returns

FileStreamResult

The created FileStreamResult for the response.

Applies to

File(Byte[], String, String)

Source:: PageModel.cs

Source:: PageModel.cs

Returns a file with the specified fileContents as content (Status200OK), the specified contentType as the Content-Type and the specified fileDownloadName as the suggested file name.

public:
 virtual Microsoft::AspNetCore::Mvc::FileContentResult ^ File(cli::array <System::Byte> ^ fileContents, System::String ^ contentType, System::String ^ fileDownloadName);

public virtual Microsoft.AspNetCore.Mvc.FileContentResult File (byte[] fileContents, string contentType, string fileDownloadName);

public virtual Microsoft.AspNetCore.Mvc.FileContentResult File (byte[] fileContents, string contentType, string? fileDownloadName);

abstract member File : byte[] * string * string -> Microsoft.AspNetCore.Mvc.FileContentResult
override this.File : byte[] * string * string -> Microsoft.AspNetCore.Mvc.FileContentResult

Public Overridable Function File (fileContents As Byte(), contentType As String, fileDownloadName As String) As FileContentResult

Parameters

fileContents: Byte[]

The file contents.

contentType: String

The Content-Type of the file.

fileDownloadName: String

The suggested file name.

Returns

FileContentResult

The created FileContentResult for the response.

Applies to

File(Stream, String)

Source:: PageModel.cs

Source:: PageModel.cs

Returns a file in the specified fileStream (Status200OK) with the specified contentType as the Content-Type.

public:
 virtual Microsoft::AspNetCore::Mvc::FileStreamResult ^ File(System::IO::Stream ^ fileStream, System::String ^ contentType);

public virtual Microsoft.AspNetCore.Mvc.FileStreamResult File (System.IO.Stream fileStream, string contentType);

abstract member File : System.IO.Stream * string -> Microsoft.AspNetCore.Mvc.FileStreamResult
override this.File : System.IO.Stream * string -> Microsoft.AspNetCore.Mvc.FileStreamResult

Public Overridable Function File (fileStream As Stream, contentType As String) As FileStreamResult

Parameters

fileStream: Stream

The Stream with the contents of the file.

contentType: String

The Content-Type of the file.

Returns

FileStreamResult

The created FileStreamResult for the response.

Applies to

File(Byte[], String)

Source:: PageModel.cs

Source:: PageModel.cs

Returns a file with the specified fileContents as content (Status200OK) and the specified contentType as the Content-Type.

public:
 virtual Microsoft::AspNetCore::Mvc::FileContentResult ^ File(cli::array <System::Byte> ^ fileContents, System::String ^ contentType);

public virtual Microsoft.AspNetCore.Mvc.FileContentResult File (byte[] fileContents, string contentType);

abstract member File : byte[] * string -> Microsoft.AspNetCore.Mvc.FileContentResult
override this.File : byte[] * string -> Microsoft.AspNetCore.Mvc.FileContentResult

Public Overridable Function File (fileContents As Byte(), contentType As String) As FileContentResult

Parameters

fileContents: Byte[]

The file contents.

contentType: String

The Content-Type of the file.

Returns

FileContentResult

The created FileContentResult for the response.

Applies to

File(String, String)

Source:: PageModel.cs

Source:: PageModel.cs

Returns the file specified by virtualPath (Status200OK) with the specified contentType as the Content-Type.

public:
 virtual Microsoft::AspNetCore::Mvc::VirtualFileResult ^ File(System::String ^ virtualPath, System::String ^ contentType);

public virtual Microsoft.AspNetCore.Mvc.VirtualFileResult File (string virtualPath, string contentType);

abstract member File : string * string -> Microsoft.AspNetCore.Mvc.VirtualFileResult
override this.File : string * string -> Microsoft.AspNetCore.Mvc.VirtualFileResult

Public Overridable Function File (virtualPath As String, contentType As String) As VirtualFileResult

Parameters

virtualPath: String

The virtual path of the file to be returned.

contentType: String

The Content-Type of the file.

Returns

VirtualFileResult

The created VirtualFileResult for the response.

Applies to

PageModel.File Method

Definition

Overloads

File(String, String, String)

Parameters

Returns

Applies to

File(Stream, String, String)

Parameters

Returns

Applies to

File(Byte[], String, String)

Parameters

Returns

Applies to

File(Stream, String)

Parameters

Returns

Applies to

File(Byte[], String)

Parameters

Returns

Applies to

File(String, String)

Parameters

Returns

Applies to

Feedback

Feedback

Additional resources