CKFinder 3 – ASP.NET Connector Documentation
ResizedImageFile Class Reference

A resized image file. More...

Public Member Functions

 ResizedImageFile (IImageFile originalFile, Size size)
 Constructs a new instance of ResizedImageFile. More...
 
Task< Stream > ReadAsync (CancellationToken cancellationToken)
 Asynchronously reads resized image content. More...
 
Task< string > GetUrlAsync (CancellationToken cancellationToken)
 Asynchronously gets file url. More...
 
async Task< FileInfo > GetFileInfoAsync (CancellationToken cancellationToken)
 Asynchronously gets file information. More...
 

Properties

IImageFile OriginalFile [get]
 Gets original image file. More...
 
string Name [get]
 Gets resized image name. More...
 
Size Size [get]
 Gets resized image size. More...
 
string FullPath [get, set]
 Gets resized image absolute path. More...
 

Detailed Description

A resized image file.

Constructor & Destructor Documentation

◆ ResizedImageFile()

ResizedImageFile ( IImageFile  originalFile,
Size  size 
)
inline

Constructs a new instance of ResizedImageFile.

Parameters
originalFileAn original image file.
sizeA resized image size.

Member Function Documentation

◆ GetFileInfoAsync()

async Task<FileInfo> GetFileInfoAsync ( CancellationToken  cancellationToken)
inline

Asynchronously gets file information.

Parameters
cancellationTokenA cancellation token.
Returns
A FileInfo structure.

◆ GetUrlAsync()

Task<string> GetUrlAsync ( CancellationToken  cancellationToken)
inline

Asynchronously gets file url.

If a file system should generate Proxy commands, a file url should be retreived with help of IProxyUrlGenerator.

Parameters
cancellationTokenA cancellation token.
Returns
A file url.

◆ ReadAsync()

Task<Stream> ReadAsync ( CancellationToken  cancellationToken)
inline

Asynchronously reads resized image content.

Parameters
cancellationTokenA cancellation token.
Returns
A stream with resized image data.

Property Documentation

◆ FullPath

string FullPath
getset

Gets resized image absolute path.

◆ Name

string Name
get

Gets resized image name.

◆ OriginalFile

IImageFile OriginalFile
get

Gets original image file.

◆ Size

Size Size
get

Gets resized image size.


The documentation for this class was generated from the following file: