Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Struct

OfficeImagePlacement

OfficeIMO.Drawing

Namespace
OfficeIMO.Drawing
Assembly
OfficeIMO.Core
Source revision
ba882f6b0d07 with working tree changes
Base
ValueType
Modifiers
sealed

Describes the destination rectangle used when placing an image into a target box.

Inheritance

  • ValueType
  • OfficeImagePlacement

Usage

Explore 11 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Accepted by parameters 5

Constructors

public OfficeImagePlacement(double x, double y, double width, double height) #

Creates a new image placement rectangle.

Parameters

x double required
y double required
width double required
height double required

Methods

public static bool ExceedsAspectRatioDistortion(double sourceWidth, double sourceHeight, double targetWidth, double targetHeight, double thresholdRatio) #

Returns whether a source image would visibly distort when stretched into a target rectangle.

Parameters

sourceWidth double required
Source image width.
sourceHeight double required
Source image height.
targetWidth double required
Target rectangle width.
targetHeight double required
Target rectangle height.
thresholdRatio double required
Minimum distortion ratio considered visible. Values below 1 are invalid.

Returns

bool
public static OfficeImagePlacement Fit(double sourceWidth, double sourceHeight, double targetX, double targetY, double targetWidth, double targetHeight, OfficeImageFit fit = Stretch) #

Fits a source image into a target rectangle using the requested image fit mode.

Parameters

sourceWidth double required
Source image width.
sourceHeight double required
Source image height.
targetX double required
Target rectangle left coordinate.
targetY double required
Target rectangle top coordinate.
targetWidth double required
Target rectangle width.
targetHeight double required
Target rectangle height.
fit OfficeIMO.Drawing.OfficeImageFit = Stretch optional
Image fit mode.

Returns

OfficeImagePlacement The destination rectangle to render.
public static double GetAspectRatioDistortionRatio(double sourceWidth, double sourceHeight, double targetWidth, double targetHeight) #

Calculates the visible aspect-ratio change between a source image and a target rectangle.

Parameters

sourceWidth double required
Source image width.
sourceHeight double required
Source image height.
targetWidth double required
Target rectangle width.
targetHeight double required
Target rectangle height.

Returns

double A ratio greater than or equal to 1 where 1 means the source and target aspect ratios match.
public ValueTuple<double, double, double, double> ToTuple() #

Converts the placement into a tuple.

Returns

ValueTuple<double, double, double, double>

Properties

public double X { get; } #

Destination left coordinate.

public double Y { get; } #

Destination top coordinate.

public double Width { get; } #

Destination width.

public double Height { get; } #

Destination height.