C# Class FFImageLoading.FFImage

Inheritance: Windows.UI.Xaml.Controls.ContentControl, IDisposable

Show file Open project: daniel-luberda/FFImageLoading

Public Properties

Property	Type	Description
CacheDurationProperty	Windows.UI.Xaml.DependencyProperty
CacheTypeProperty	Windows.UI.Xaml.DependencyProperty
DownsampleHeightProperty	Windows.UI.Xaml.DependencyProperty
DownsampleModeProperty	Windows.UI.Xaml.DependencyProperty
DownsampleToViewSizeProperty	Windows.UI.Xaml.DependencyProperty
DownsampleUseDipUnitsProperty	Windows.UI.Xaml.DependencyProperty
DownsampleWidthProperty	Windows.UI.Xaml.DependencyProperty
ErrorCommandProperty	Windows.UI.Xaml.DependencyProperty
ErrorPlaceholderProperty	Windows.UI.Xaml.DependencyProperty
FadeAnimationEnabledProperty	Windows.UI.Xaml.DependencyProperty
FinishCommandProperty	Windows.UI.Xaml.DependencyProperty
LoadingPlaceholderProperty	Windows.UI.Xaml.DependencyProperty
LoadingPriorityProperty	Windows.UI.Xaml.DependencyProperty
RetryCountProperty	Windows.UI.Xaml.DependencyProperty
RetryDelayProperty	Windows.UI.Xaml.DependencyProperty
SourceProperty	Windows.UI.Xaml.DependencyProperty
StretchProperty	Windows.UI.Xaml.DependencyProperty
SuccessCommandProperty	Windows.UI.Xaml.DependencyProperty
TransformPlaceholdersProperty	Windows.UI.Xaml.DependencyProperty
TransformationsProperty	Windows.UI.Xaml.DependencyProperty

Private Properties

Property	Type	Description
GetBytesFromBitmapAsync	Task
GetImageAsByteAsync	Task
LoadImage	void
OnError	void
OnFinish	void
OnSuccess	void
SourcePropertyChanged	void
SourcePropertyChanged	void
StretchPropertyChanged	void
StretchPropertyChanged	void
TransformationsPropertyChanged	void
TransformationsPropertyChanged	void

Public Methods

Method	Description
Cancel ( ) : void	Cancels image loading tasks
ClearCacheAsync ( CacheType cacheType ) : Task	Clears image cache
Dispose ( ) : void
FFImage ( ) : FFImageLoading.Extensions
GetImageAsJpgAsync ( int quality = 90, int desiredWidth, int desiredHeight ) : Task	Gets the image as JPG.
GetImageAsPngAsync ( int desiredWidth, int desiredHeight ) : Task	Gets the image as PNG
InvalidateCacheEntryAsync ( string key, CacheType cacheType ) : Task	Invalidates cache for a specified key
SetPauseWork ( bool pauseWork ) : void	Pauses image loading (enable or disable).

Private Methods

Method	Description
GetBytesFromBitmapAsync ( WriteableBitmap bitmap ) : Task
GetImageAsByteAsync ( System.Guid format, int quality, int desiredWidth, int desiredHeight ) : Task
LoadImage ( ) : void
OnError ( Args e ) : void
OnFinish ( Args e ) : void
OnSuccess ( Args e ) : void
SourcePropertyChanged ( DependencyObject d, DependencyPropertyChangedEventArgs e ) : void
SourcePropertyChanged ( string source ) : void
StretchPropertyChanged ( DependencyObject d, DependencyPropertyChangedEventArgs e ) : void
StretchPropertyChanged ( Stretch stretch ) : void
TransformationsPropertyChanged ( DependencyObject d, DependencyPropertyChangedEventArgs e ) : void
TransformationsPropertyChanged ( List transformations ) : void

Method Details

Cancel() public method

Cancels image loading tasks

public Cancel ( ) : void
return	void

ClearCacheAsync() public static method

Clears image cache

public static ClearCacheAsync ( CacheType cacheType ) : Task
cacheType	CacheType	Cache type to invalidate
return	Task

Dispose() public method

public Dispose ( ) : void
return	void

FFImage() public method

public FFImage ( ) : FFImageLoading.Extensions
return	FFImageLoading.Extensions

GetImageAsJpgAsync() public method

Gets the image as JPG.

public GetImageAsJpgAsync ( int quality = 90, int desiredWidth, int desiredHeight ) : Task
quality	int
desiredWidth	int
desiredHeight	int
return	Task

GetImageAsPngAsync() public method

Gets the image as PNG

public GetImageAsPngAsync ( int desiredWidth, int desiredHeight ) : Task
desiredWidth	int
desiredHeight	int
return	Task

InvalidateCacheEntryAsync() public static method

Invalidates cache for a specified key

public static InvalidateCacheEntryAsync ( string key, CacheType cacheType ) : Task
key	string	Key to invalidate
cacheType	CacheType	Cache type to invalidate
return	Task

SetPauseWork() public static method

Pauses image loading (enable or disable).

public static SetPauseWork ( bool pauseWork ) : void
pauseWork	bool	If set to true pauses image loading.
return	void

Property Details

CacheDurationProperty public static property

The cache duration property.

public static DependencyProperty,Windows.UI.Xaml CacheDurationProperty
return	Windows.UI.Xaml.DependencyProperty

CacheTypeProperty public static property

The cache type property.

public static DependencyProperty,Windows.UI.Xaml CacheTypeProperty
return	Windows.UI.Xaml.DependencyProperty

DownsampleHeightProperty public static property

The downsample height property.

public static DependencyProperty,Windows.UI.Xaml DownsampleHeightProperty
return	Windows.UI.Xaml.DependencyProperty

DownsampleModeProperty public static property

The downsample interpolation mode property.

public static DependencyProperty,Windows.UI.Xaml DownsampleModeProperty
return	Windows.UI.Xaml.DependencyProperty

DownsampleToViewSizeProperty public static property

public static DependencyProperty,Windows.UI.Xaml DownsampleToViewSizeProperty
return	Windows.UI.Xaml.DependencyProperty

DownsampleUseDipUnitsProperty public static property

public static DependencyProperty,Windows.UI.Xaml DownsampleUseDipUnitsProperty
return	Windows.UI.Xaml.DependencyProperty

DownsampleWidthProperty public static property

The downsample width property.

public static DependencyProperty,Windows.UI.Xaml DownsampleWidthProperty
return	Windows.UI.Xaml.DependencyProperty

ErrorCommandProperty public static property

The ErrorCommandProperty.

public static DependencyProperty,Windows.UI.Xaml ErrorCommandProperty
return	Windows.UI.Xaml.DependencyProperty

ErrorPlaceholderProperty public static property

The error placeholder property.

public static DependencyProperty,Windows.UI.Xaml ErrorPlaceholderProperty
return	Windows.UI.Xaml.DependencyProperty

FadeAnimationEnabledProperty public static property

The fade animation enabled property.

public static DependencyProperty,Windows.UI.Xaml FadeAnimationEnabledProperty
return	Windows.UI.Xaml.DependencyProperty

FinishCommandProperty public static property

The FinishCommandProperty.

public static DependencyProperty,Windows.UI.Xaml FinishCommandProperty
return	Windows.UI.Xaml.DependencyProperty

LoadingPlaceholderProperty public static property

The loading placeholder property.

public static DependencyProperty,Windows.UI.Xaml LoadingPlaceholderProperty
return	Windows.UI.Xaml.DependencyProperty

LoadingPriorityProperty public static property

The Loading Priority property.

public static DependencyProperty,Windows.UI.Xaml LoadingPriorityProperty
return	Windows.UI.Xaml.DependencyProperty

RetryCountProperty public static property

The retry count property.

public static DependencyProperty,Windows.UI.Xaml RetryCountProperty
return	Windows.UI.Xaml.DependencyProperty

RetryDelayProperty public static property

The retry delay property.

public static DependencyProperty,Windows.UI.Xaml RetryDelayProperty
return	Windows.UI.Xaml.DependencyProperty

SourceProperty public static property

public static DependencyProperty,Windows.UI.Xaml SourceProperty
return	Windows.UI.Xaml.DependencyProperty

StretchProperty public static property

public static DependencyProperty,Windows.UI.Xaml StretchProperty
return	Windows.UI.Xaml.DependencyProperty

SuccessCommandProperty public static property

The SuccessCommandProperty.

public static DependencyProperty,Windows.UI.Xaml SuccessCommandProperty
return	Windows.UI.Xaml.DependencyProperty

TransformPlaceholdersProperty public static property

The transform placeholders property.

public static DependencyProperty,Windows.UI.Xaml TransformPlaceholdersProperty
return	Windows.UI.Xaml.DependencyProperty

TransformationsProperty public static property

The transformations property.

public static DependencyProperty,Windows.UI.Xaml TransformationsProperty
return	Windows.UI.Xaml.DependencyProperty