Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

OfficeRadialGradient

Namespace OfficeIMO.Drawing
Assembly OfficeIMO.Core
Source revision 45ddf07f0b84 with working tree changes
Modifiers sealed

Dependency-free radial gradient intent in normalized local coordinates. Coordinates use a top-left origin and are mapped through CoordinateTransform into normalized shape coordinates. With the identity transform, 0,0 is the shape's top-left corner and 1,1 is its bottom-right corner. Ellipse centers may sit outside that box to preserve authored gradients whose focal point is off-canvas. Pixels unreached by a physical circle remain transparent; native-format adapters may explicitly supply outside endpoint paint. Independent horizontal and vertical radii allow ellipses before the affine coordinate transform while the original circle constructors remain source-compatible.

Inheritance

  • Object
  • OfficeRadialGradient

Usage

Explore 10 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 3

Constructors

OfficeRadialGradient 3 overloads
public OfficeRadialGradient(Double startX, Double startY, Double startRadius, Double endX, Double endY, Double endRadius, OfficeGradientStop start, OfficeGradientStop end) #

Creates a radial gradient between two circles.

Parameters

startX System.Double requiredposition: 0
startY System.Double requiredposition: 1
startRadius System.Double requiredposition: 2
endX System.Double requiredposition: 3
endY System.Double requiredposition: 4
endRadius System.Double requiredposition: 5
start OfficeIMO.Drawing.OfficeGradientStop requiredposition: 6
end OfficeIMO.Drawing.OfficeGradientStop requiredposition: 7
public OfficeRadialGradient(Double startX, Double startY, Double startRadius, Double endX, Double endY, Double endRadius, IReadOnlyList<OfficeGradientStop> stops) #

Creates a radial gradient between two circles with two or more ordered stops.

Parameters

startX System.Double requiredposition: 0
startY System.Double requiredposition: 1
startRadius System.Double requiredposition: 2
endX System.Double requiredposition: 3
endY System.Double requiredposition: 4
endRadius System.Double requiredposition: 5
stops System.Collections.Generic.IReadOnlyList<OfficeIMO.Drawing.OfficeGradientStop> requiredposition: 6
public OfficeRadialGradient(Double startX, Double startY, Double startRadiusX, Double startRadiusY, Double endX, Double endY, Double endRadiusX, Double endRadiusY, IReadOnlyList<OfficeGradientStop> stops) #

Creates a radial gradient between two axis-aligned ellipses with the same aspect ratio.

Parameters

startX System.Double requiredposition: 0
startY System.Double requiredposition: 1
startRadiusX System.Double requiredposition: 2
startRadiusY System.Double requiredposition: 3
endX System.Double requiredposition: 4
endY System.Double requiredposition: 5
endRadiusX System.Double requiredposition: 6
endRadiusY System.Double requiredposition: 7
stops System.Collections.Generic.IReadOnlyList<OfficeIMO.Drawing.OfficeGradientStop> requiredposition: 8

Methods

public static OfficeRadialGradient Centered(OfficeColor startColor, OfficeColor endColor) #
Returns: OfficeRadialGradient

Creates a centered radial gradient from the center outward.

Parameters

startColor OfficeIMO.Drawing.OfficeColor requiredposition: 0
endColor OfficeIMO.Drawing.OfficeColor requiredposition: 1
public OfficeRadialGradient Clone() #
Returns: OfficeRadialGradient

Creates a detached copy.

public OfficeRadialGradient TransformCoordinates(OfficeTransform transform) #
Returns: OfficeRadialGradient

Returns a gradient transformed in normalized shape coordinates, preserving its circular or elliptical field.

Parameters

transform OfficeIMO.Drawing.OfficeTransform requiredposition: 0

Exceptions

  • ArgumentException – The combined transform cannot be inverted.
public OfficeRadialGradient WithColorInterpolation(OfficeGradientColorInterpolation interpolation) #
Returns: OfficeRadialGradient

Returns a detached gradient using the specified color interpolation space.

Parameters

interpolation OfficeIMO.Drawing.OfficeGradientColorInterpolation requiredposition: 0
public OfficeRadialGradient WithSpreadMode(OfficeGradientSpreadMode spreadMode) #
Returns: OfficeRadialGradient

Returns a detached gradient with the requested spread behavior.

Parameters

spreadMode OfficeIMO.Drawing.OfficeGradientSpreadMode requiredposition: 0

Properties

public OfficeTransform CoordinateTransform { get; private set; } #

Affine mapping from gradient coordinates to normalized shape coordinates.

public Double StartX { get; } #

Start circle center X coordinate in gradient-coordinate units.

public Double StartY { get; } #

Start circle center Y coordinate in gradient-coordinate units.

public Double StartRadius { get; } #

Start circle radius, or the horizontal radius for an elliptical definition.

public Double StartRadiusX { get; } #

Horizontal start ellipse radius.

public Double StartRadiusY { get; } #

Vertical start ellipse radius.

public Double EndX { get; } #

End circle center X coordinate in gradient-coordinate units.

public Double EndY { get; } #

End circle center Y coordinate in gradient-coordinate units.

public Double EndRadius { get; } #

End circle radius, or the horizontal radius for an elliptical definition.

public Double EndRadiusX { get; } #

Horizontal end ellipse radius.

public Double EndRadiusY { get; } #

Vertical end ellipse radius.

public OfficeGradientColorInterpolation ColorInterpolation { get; private set; } #

Color space used to interpolate RGB channels between stops. Defaults to encoded sRGB.

public IReadOnlyList<OfficeGradientStop> Stops { get; private set; } #

Gradient stops in offset order.

public OfficeGradientSpreadMode SpreadMode { get; private set; } #

Behavior beyond the stop interval. Defaults to endpoint padding.