API Reference
OfficeClipPath
Dependency-free clipping path descriptor in local top-left coordinates.
Inheritance
- Object
- OfficeClipPath
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Method OfficeClipPath.Clone
- Method OfficeClipPath.Empty
- Method OfficeClipPath.Path
- Method OfficeClipPath.Path
- Method OfficeClipPath.Path
- Method OfficeClipPath.Rectangle
- Method OfficeClipPath.RoundedRectangle
- Method OfficeClipPath.Scale
- Property OfficeDrawingGroup.ClipPath
- Property OfficeShape.ClipPath
Accepted by parameters
- Method OfficeDrawing.AddClippedDrawing
- Method OfficeDrawing.AddClippedDrawing
- Method OfficeDrawing.AddClippedDrawing
- Method OfficeDrawing.AddClippedDrawing
- Method OfficeDrawing.AddClippedImage
- Method OfficeDrawing.AddClippedImageWithInterpolation
- Method OfficeDrawing.AddClippedPositionedText
- Method OfficeDrawing.AddClippedPositionedText
- Method OfficeDrawing.AddClippedText
- Constructor OfficeDrawingGroup.OfficeDrawingGroup
- Constructor OfficeDrawingGroup.OfficeDrawingGroup
- Constructor OfficeDrawingGroup.OfficeDrawingGroup
- Constructor OfficeDrawingGroup.OfficeDrawingGroup
Methods
public OfficeClipPath Clone() #OfficeClipPathCreates a detached copy of this clipping path.
public static OfficeClipPath Path(params OfficePathCommand[] commands) #OfficeClipPathCreates a freeform clipping path from commands in local top-left coordinates.
Parameters
- commands OfficeIMO.Drawing.OfficePathCommand[]
public static OfficeClipPath Path(IEnumerable<OfficePathCommand> commands) #OfficeClipPathCreates a freeform clipping path from commands in local top-left coordinates.
Parameters
- commands System.Collections.Generic.IEnumerable{OfficeIMO.Drawing.OfficePathCommand}
public static OfficeClipPath Path(IEnumerable<OfficePathCommand> commands, OfficeFillRule fillRule) #OfficeClipPathCreates a freeform clipping path from commands in local top-left coordinates.
Parameters
- commands System.Collections.Generic.IEnumerable{OfficeIMO.Drawing.OfficePathCommand}
- fillRule OfficeIMO.Drawing.OfficeFillRule
public static OfficeClipPath Rectangle(Double width, Double height) #OfficeClipPathCreates a rectangular clipping path from the shape's local top-left corner.
Parameters
- width System.Double
- height System.Double
public static OfficeClipPath RoundedRectangle(Double width, Double height, Double cornerRadius) #OfficeClipPathCreates a rounded rectangular clipping path from the shape's local top-left corner.
Parameters
- width System.Double
- height System.Double
- cornerRadius System.Double
public OfficeClipPath Scale(Double scaleX, Double scaleY) #OfficeClipPathCreates a scaled detached copy of this clipping path.
Parameters
- scaleX System.Double
- Horizontal scale factor.
- scaleY System.Double
- Vertical scale factor.
Returns
A new clipping path scaled in local coordinates.
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public OfficeClipPathKind Kind { get; set; } #Clip path type.
public Double Width { get; set; } #Clip path width in the caller's layout unit.
public Double Height { get; set; } #Clip path height in the caller's layout unit.
public Double CornerRadius { get; set; } #Corner radius for rounded rectangle clipping paths.
public IReadOnlyList<OfficePathCommand> Commands { get; set; } #Local commands for freeform clipping paths.
public OfficeFillRule FillRule { get; set; } #Fill rule used when the clipping path contains multiple contours.