Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/
Class

OfficeClipPath

OfficeIMO.Drawing

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

Dependency-free clipping path descriptor in local top-left coordinates.

Inheritance

  • object
  • OfficeClipPath

Usage

Explore 14 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 6

Methods

public OfficeClipPath Clone() #

Creates a detached copy of this clipping path.

public static OfficeClipPath Empty() #

Creates an empty clipping region.

Path 4 overloads
public static OfficeClipPath Path(params OfficePathCommand[] commands) #

Creates a freeform clipping path from commands in local top-left coordinates.

Parameters

commands OfficeIMO.Drawing.OfficePathCommand[] required
public static OfficeClipPath Path(IEnumerable<OfficePathCommand> commands) #

Creates a freeform clipping path from commands in local top-left coordinates.

Parameters

commands System.Collections.Generic.IEnumerable<OfficeIMO.Drawing.OfficePathCommand> required
public static OfficeClipPath Path(IEnumerable<OfficePathCommand> commands, OfficeFillRule fillRule) #

Creates a freeform clipping path from commands in local top-left coordinates.

Parameters

commands System.Collections.Generic.IEnumerable<OfficeIMO.Drawing.OfficePathCommand> required
fillRule OfficeIMO.Drawing.OfficeFillRule required
public static OfficeClipPath Path(double width, double height, IEnumerable<OfficePathCommand> commands, OfficeFillRule fillRule = EvenOdd) #

Creates a clipping path while retaining its coordinates within a declared local canvas.

Parameters

width double required
height double required
commands System.Collections.Generic.IEnumerable<OfficeIMO.Drawing.OfficePathCommand> required
fillRule OfficeIMO.Drawing.OfficeFillRule = EvenOdd optional
public static OfficeClipPath Rectangle(double width, double height) #

Creates a rectangular clipping path from the shape's local top-left corner.

Parameters

width double required
height double required
public static OfficeClipPath RoundedRectangle(double width, double height, double cornerRadius) #

Creates a rounded rectangular clipping path from the shape's local top-left corner.

Parameters

width double required
height double required
cornerRadius double required
public OfficeClipPath Scale(double scaleX, double scaleY) #

Creates a scaled detached copy of this clipping path.

Parameters

scaleX double required
Horizontal scale factor.
scaleY double required
Vertical scale factor.

Returns

OfficeClipPath A new clipping path scaled in local coordinates.

Properties

public OfficeClipPathKind Kind { get; private set; } #

Clip path type.

public double Width { get; private set; } #

Clip path width in the caller's layout unit.

public double Height { get; private set; } #

Clip path height in the caller's layout unit.

public double CornerRadius { get; private set; } #

Corner radius for rounded rectangle clipping paths.

public IReadOnlyList<OfficePathCommand> Commands { get; private set; } #

Local commands for freeform clipping paths.

public OfficeFillRule FillRule { get; private set; } #

Fill rule used when the clipping path contains multiple contours.