Class ImageDocument

Namespace

The.Documents

Assembly

Instagile.dll

public sealed class ImageDocument : DocumentBase, IComparable<DocumentBase>, IDocument

Inheritance

object

DocumentBase

ImageDocument

Implements

IComparable<DocumentBase>

IDocument

Inherited Members

DocumentBase.Service

DocumentBase.ID

DocumentBase.Access

DocumentBase.DownloadAsync(IPrincipal, CancellationToken?)

DocumentBase.DownloadAsync(CancellationToken)

DocumentBase.DownloadBufferAsync(IPrincipal, CancellationToken?)

DocumentBase.DownloadBufferAsync(CancellationToken)

DocumentBase.DownloadFileAsync(string, IPrincipal, CancellationToken?)

DocumentBase.DownloadFileAsync(string, CancellationToken)

DocumentBase.CompareTo(DocumentBase)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ImageExtensions.GetFlippedHorizontallyAsync(ImageDocument, IPrincipal?, CancellationToken?, DocumentAccessRule?)

ImageExtensions.GetFlippedVerticallyAsync(ImageDocument, IPrincipal?, CancellationToken?, DocumentAccessRule?)

ImageExtensions.GetRotationAsync(ImageDocument, int, IPrincipal?, CancellationToken?, DocumentAccessRule?)

ImageExtensions.GetThumbnailAsync(ImageDocument, int?, int?, string?, IPrincipal?, CancellationToken?)

ImageExtensions.GetThumbnailAsync(ImageDocument, ImageMetadata, int?, int?, string?, IPrincipal?, CancellationToken?)

Constructors

ImageDocument(DocumentService, Guid, DocumentAccessAssertion)

public ImageDocument(DocumentService service, Guid id, DocumentAccessAssertion access)

Parameters

service DocumentService

id Guid

access DocumentAccessAssertion

Methods

AdjustAspectRatio(int, int, int?, int?, out int, out int)

Modify one of the provided image dimensions to match the aspect ratio of another image size.

public static void AdjustAspectRatio(int originalWidth, int originalHeight, int? containerWidth, int? containerHeight, out int finalWidth, out int finalHeight)

Parameters

originalWidth int

originalHeight int

containerWidth int?

containerHeight int?

finalWidth int

finalHeight int

Remarks

If newX was null or newY was null, sets the one that was null. Otherwise, sets the one that has to reduce. After returning, neither newX nor newY will be null.

GetMetadataAsync(CancellationToken)

public Task<ImageMetadata> GetMetadataAsync(CancellationToken cancellationToken)

Parameters

cancellationToken CancellationToken

Returns

Task<ImageMetadata>

GetMetadataAsync(IPrincipal?, CancellationToken?)

public Task<ImageMetadata> GetMetadataAsync(IPrincipal? principal = null, CancellationToken? cancellationToken = null)

Parameters

principal IPrincipal

cancellationToken CancellationToken?

Returns

Task<ImageMetadata>